Pelican Alchemy

A magical ✨ Pelican theme

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

Inspired by crowsfoot and clean-blog, it features:

• Powered by Bootstrap 4 (v4.0.0-beta.3)
• Font Awesome icons
• Pygments syntax highlighting styles
• Pelican sitemap.xml support
• Favicon Generator support
• External analytics (Google, Gauges, Piwik) support **
• External comments (Disqus) support **

** Features link to external assets (webfonts etc).

Installation

From Git repo

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'

With pip

Alternatively, you can install this theme with pip:

pip install "https://github.com/nairobilug/pelican-alchemy/tarball/master"

And import it from Pelican config:

import alchemy
THEME = alchemy.path()

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.
• BOOTSTRAP_CSS: URL of Bootstrap CSS file. Use this to enable Boostwatch themes.
• 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.
• THEME_CSS_OVERRIDES: Sequence of stylesheet URLs to override CSS provided by theme. Both relative and absolute URLs are supported.

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

How to Contribute

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
2. Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
3. Send a pull request and bug the maintainer until it gets merged and published. :)

Alchemy follows the Contributor Covenant code of conduct.

License

MIT © 2017 Nairobi GNU/Linux Users Group