Document supported theme settings in the readme

This commit is contained in:
Arnaud Rebillout
2020-07-26 15:24:28 +07:00
parent b3ad890a46
commit 96b87d97d9
+19
View File
@@ -8,3 +8,22 @@ You can see a live demo [here](http://jvanz.github.io/)
![Screenshot](screenshot.png) ![Screenshot](screenshot.png)
Pull requests are welcome Pull requests are welcome
## Settings
List of Pelican's settings that are supported by this theme. Refer to the
[Pelican's documentation](https://docs.getpelican.com/en/stable/settings.html)
for more details.
- `FEED_*` and `*_FEED_*`
- `DISQUS_SITENAME`
- `GOOGLE_ANALYTICS`
- `GA_COOKIE_DOMAIN`
- `SITESUBTITLE`
Additional settings:
- `BIO` - short biography to display in the sidebar, eg. `Hello world`
- `PROFILE_IMAGE` - image to display in the sidebar, eg. `avatar.png`
- `FONT_AWESOME` - Fontawesome kit, eg `https://kit.fontawesome.com/{{ FONT_AWESOME }}.js`