diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 37 insertions, 13 deletions
@@ -20,19 +20,43 @@ Set `THEME = "moeka"` in your `pelicanconf.py`. ## Settings -This theme supports the following settings (set them in your `pelicanconf.py`): - -`ATTRIBUTION`: If `True`, shows a small line at the bottom of the page linking to this theme. - -`CONTENT_LICENCE`: If set, shows as a line that notes under which licence the content on your website is available. If this starts with "CC-BY-SA", the theme also shows the Creative Commons icons. - -`GITHUB`: The URL of your GitHub profile. If set, shows a GitHub icon that links to your profile. - -`GITLAB`: The URL of your GitLab profile. If set, shows a GitLab icon that links to your profile. - -`CODEBERG`: The URL of your Codeberg profile. If set, shows a Codeberg icon that links to your profile. - -`MASTODON`: The URL of your Mastodon profile. If set, shows a Mastodon icon that links to your profile. +This theme supports the following settings (set them in your `pelicanconf.py`). +All of them are optional, if not given, the element will simply be hidden: + +```python +# Menu items as a list of (title, url) tuples, like in the standard theme. +# See https://docs.getpelican.com/en/4.9.1/settings.html#MENUITEMS +MENUITEMS = [ + ("Pelican!", "https://getpelican.com/"), +] + +# Show a small line at the bottom of the page linking to this theme. +ATTRIBUTION = True + +# If set, shows as a line that notes under which licence the content on your +# website is available. If this starts with "CC-BY-SA", the theme also shows +# the Creative Commons icons. +CONTENT_LICENCE = "CC-BY-SA 4.0" + +# If set and True, shows the authors of articles. +DISPLAY_ARTICLE_AUTHORS = True + +# Set to the name/path (relative to the base of your site) to use the given +# image as a favicon. +FAVICON = "images/favicon.png" +# Simlarly, set this to the path of a logo image that is shown above the menu. +LOGO = "images/logo.png" + +# The URL of your GitHub profile. If set, shows a GitHub icon that links to +# your profile ... +GITHUB = "https://github.com/..." +# ... similar for GitLab ... +GITLAB = "https://gitlab.com/..." +# ... similar for Codeberg ... +CODEBERG = "https://codeberg.org/..." +# ... similar for Mastodon ... +MASTODON = "https://mastodon.social/..." +``` ## Licence |