alchemy

Pelican Alchemy

Alchemy ✨ is a functional, clean, responsive theme for the Pelican static site generator.

Inspired by crowsfoot and clean-blog, it features:

• Built with Bootstap 4 (v4-alpha)
• Favicon Generator support
• Font Awesome icons
• Pygments syntax highlighting styles
• sitemap.xml support
• External analytics (Google Analytics, Gauges, Piwik)
• External comments (Disqus)

Installation

Clone the repo:

$ git clone https://github.com/nairobilug/pelican-alchemy

Set the THEME variable in your Pelican config:

THEME = '/PATH_TO_REPO/alchemy'

As a Submodule

In your Pelican site:

$ mkdir themes
$ git submodule add https://github.com/nairobilug/pelican-alchemy themes/pelican-alchemy

And in Pelican config:

THEME = 'themes/pelican-alchemy/alchemy'

Usage

Visit the Settings wiki 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 Favicon Generator package.

Misc settings:

• DISQUS_SITENAME
• GAUGES
• GOOGLE_ANALYTICS
• PIWIK_URL
• PIWIK_SITE_ID

Example pelicanconf.py (demo website).

Tips & Tricks

https://github.com/nairobilug/pelican-alchemy/wiki/Tips

Maintainers

• @nairobilug

Contribute

Feel free to dive in. Open an issue or submit a PR.

Alchemy follows the Contributor Covenant code of conduct.

License

MIT © Nairobi GNU/Linux Users Group