Go to file
Raymond Wanyoike 38201b83a8 Add missing copyright year 2017-11-21 15:25:36 +03:00
alchemy Make header image edges ~1px rounded 2017-11-21 15:22:29 +03:00
CODE_OF_CONDUCT.md Refresh code of conduct 2017-11-21 15:25:00 +03:00
LICENSE Add missing copyright year 2017-11-21 15:25:36 +03:00
README.md Add missing copyright year 2017-11-21 15:25:36 +03:00
screenshot.jpg Update README 2017-01-05 19:03:42 +03:00

README.md

Pelican Alchemy

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

Inspired by crowsfoot and clean-blog, it features:

Screenshot

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

Contribute

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

Alchemy follows the Contributor Covenant code of conduct.

License

MIT © 2017 Nairobi GNU/Linux Users Group