A theme for the [Pelican](http://getpelican.com) static site generator. A shameless rip off of @porterjamesj's [crowsfoot](http://github.com/porterjamesj/crowsfoot) theme.
Alchemy ✨ is a functional, clean, responsive theme for the [Pelican](http://getpelican.com) static site generator. It is heavily inspired by [crowsfoot](http://github.com/porterjamesj/crowsfoot), [clean-blog](https://github.com/BlackrockDigital/startbootstrap-clean-blog), and powered by [Bootstrap](https://github.com/twbs/bootstrap). Pull requests are welcome!
Visit the [settings page](https://nairobilug.github.io/pelican-alchemy/pages/settings.html) for examples:
-**SITESUBTITLE**: Subtitle that appears in the header.
-**SITEIMAGE**: Image that appears in the header.
-**DESCRIPTION**: Index HTML head `<meta>` description.
-**LINKS**: A list of tuples (Title, URL) for menu links.
-**ICONS**: A list of tuples (Icon, URL) for icon links.
-**PYGMENTS_STYLE**: Built-in Pygments style for syntax highlighting.
-**HIDE_AUTHORS**: Hide the author(s) of an article - useful for single author sites.
-**RFG_FAVICONS**: Use a [realfavicongenerator](https://realfavicongenerator.net/blog/new-favicon-package-less-is-more/) package.
Others:
-**DISQUS_SITENAME**
-**GAUGES**
-**GOOGLE_ANALYTICS**
-**PIWIK_URL**
-**PIWIK_SITE_ID**
Example Pelican [config](https://github.com/nairobilug/pelican-alchemy/blob/demo/pelicanconf.py)(demo site).
## Tips
### Bootstrap Classes
To have Bootstrap classes set for rendered html (`.table`, `.img-fluid` etc), use the [Bootstrapify](https://github.com/ingwinlu/pelican-bootstrapify) plugin.
In your Pelican site:
Then set the pelican config variable `THEME` to the `alchemy` folder inside the cloned path.
Use `BOOTSTRAPIFY` to pass a `{'css-selector': ['list-of-classes']}` dict to the plugin. Bootstrapify will append `list-of-classes` to all tags that match `css-selector`.
| CATEGORIES_ON_MENU | BOOL | Category link in menu |
| TAGS_ON_MENU | BOOL | Tag link in menu |
| ARCHIVES_ON_MENU | BOOL | Archives link in menu |
| PROFILE_IMAGE | URL | Profile image |
| SHOW_ARTICLE_AUTHOR | BOOL | Show/hide author |
| SITE_SUBTEXT | TEXT | Header subtitle |
To use the `RFG_FAVICONS` setting, visit [realfavicongenerator.net](https://realfavicongenerator.net/) to generate a site favicon package and download it.
Note: `EXTRA_PATH_METADATA` should correspond with the favicon package:
$ unzip -l /path/to/favicons.zip
## License
### Generate `sitemap.xml`
MIT
There is a `sitemap.html` Jinja2 template that can be used to [generate a sitemap](https://github.com/getpelican/pelican/wiki/Tips-n-Tricks#generate-sitemapxml).
In your Pelican config:
[^1]:http://realfavicongenerator.net/faq#why_so_many_files"Why so many files?"
# Default value is ['index', 'tags', 'categories', 'authors', 'archives']
