From 96b87d97d9e603158fc58a330bfed1a68486afd0 Mon Sep 17 00:00:00 2001 From: Arnaud Rebillout Date: Sun, 26 Jul 2020 15:24:28 +0700 Subject: [PATCH] Document supported theme settings in the readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 4d13fa4..e7bd75c 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,22 @@ You can see a live demo [here](http://jvanz.github.io/) ![Screenshot](screenshot.png) 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`