blog-theme/README.md

1.7 KiB

pelican-alchemy

Alchemy is a functional, clean, responsive theme for the Pelican static site generator. It is heavily inspired by crowsfoot and clean-blog, and is powered by Bootstrap (v3.x).

Demo!

Screenshot

Screenshot

Installation

First, clone the repo onto your device:

$ git clone git@github.com:rwanyoike/pelican-alchemy.git

Point the THEME variable in your pelican config to the alchemy folder:

THEME = '/path/to/pelican-alchemy/alchemy'

Alternative

Setup pelican-alchemy as a submodule:

$ mkdir themes
$ git submodule add git@github.com:rwanyoike/pelican-alchemy.git themes/pelican-alchemy

And in pelican config:

THEME = 'themes/pelican-alchemy/alchemy'

Settings

Visit the settings page for examples:

  • SITESUBTITLE: Subtitle that appears in the header.
  • SITEIMAGE: Image that appears in the header.
  • DESCRIPTION: Index page HTML head meta description tag.
  • 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.
  • NEW_FAVICONS: Use a realfavicongenerator favicon package.

Others:

  • DISQUS_SITENAME
  • GAUGES
  • GOOGLE_ANALYTICS
  • PIWIK_URL
  • PIWIK_SITE_ID

Pull requests are welcome! ☺️