2013-11-25 05:59:15 +01:00
# pelican-alchemy
2017-03-07 10:09:00 +01:00
Alchemy ✨ is a functional, clean, responsive theme for the [Pelican ](http://getpelican.com ) static site generator. Inspired by [crowsfoot ](http://github.com/porterjamesj/crowsfoot ) and [clean-blog ](https://github.com/BlackrockDigital/startbootstrap-clean-blog ).
2016-11-08 06:24:42 +01:00
2016-11-29 14:18:03 +01:00
## Screenshot
2016-11-08 06:24:42 +01:00
2016-11-29 14:18:03 +01:00
![Screenshot ](screenshot.jpg "Screenshot" )
2016-11-29 13:05:39 +01:00
2016-12-01 11:22:37 +01:00
## Features
2017-03-07 10:09:00 +01:00
- Powered by [Bootstap 4 ](http://v4-alpha.getbootstrap.com/ )
- [Favicon Generator ](http://realfavicongenerator.net/ ) support
- [Font Awesome ](http://fontawesome.io/ ) icons
- [Pygments ](http://pygments.org/ ) syntax highlighting styles
- `sitemap.xml` support
2016-12-01 11:22:37 +01:00
- External analytics (Google Analytics, Gauges, Piwik)
- External comments (Disqus)
2016-11-29 14:18:03 +01:00
## Installation
2016-11-29 13:05:39 +01:00
2017-03-07 10:09:00 +01:00
Clone the repo:
2016-11-29 13:05:39 +01:00
2017-03-07 10:09:00 +01:00
$ git clone https://github.com/nairobilug/pelican-alchemy
2016-11-29 13:05:39 +01:00
2017-03-07 10:09:00 +01:00
Set the `THEME` variable in your Pelican config:
2016-11-29 13:05:39 +01:00
2017-03-07 10:09:00 +01:00
THEME = '/PATH_TO_REPO/alchemy'
2016-11-29 13:05:39 +01:00
2017-01-05 18:16:08 +01:00
### As a submodule
2016-11-29 13:05:39 +01:00
2016-12-01 11:22:37 +01:00
In your Pelican site:
2016-11-29 13:05:39 +01:00
2016-11-29 14:18:03 +01:00
$ mkdir themes
2016-12-02 21:10:21 +01:00
$ git submodule add https://github.com/nairobilug/pelican-alchemy themes/pelican-alchemy
2016-11-29 13:05:39 +01:00
2016-12-01 11:22:37 +01:00
And Pelican config:
2016-11-29 13:05:39 +01:00
2016-11-29 14:18:03 +01:00
THEME = 'themes/pelican-alchemy/alchemy'
2016-11-29 13:05:39 +01:00
2016-11-29 14:18:03 +01:00
## Settings
2016-11-29 13:05:39 +01:00
2017-03-07 10:09:00 +01:00
Visit the [Settings wiki ](https://github.com/nairobilug/pelican-alchemy/wiki/Settings ) for examples:
2016-11-29 13:05:39 +01:00
2016-11-29 14:18:03 +01:00
- **SITESUBTITLE**: Subtitle that appears in the header.
- **SITEIMAGE**: Image that appears in the header.
2016-12-01 11:22:37 +01:00
- **DESCRIPTION**: Index HTML head `<meta>` description.
2016-11-29 14:18:03 +01:00
- **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.
2016-12-01 11:22:37 +01:00
- **HIDE_AUTHORS**: Hide the author(s) of an article - useful for single author sites.
2017-03-07 10:09:00 +01:00
- **RFG_FAVICONS**: Use a Favicon Generator package.
2016-11-29 13:05:39 +01:00
2017-03-07 10:09:00 +01:00
Misc settings:
2016-11-29 13:05:39 +01:00
2016-11-29 14:18:03 +01:00
- **DISQUS_SITENAME**
- **GAUGES**
- **GOOGLE_ANALYTICS**
- **PIWIK_URL**
- **PIWIK_SITE_ID**
2016-11-29 13:05:39 +01:00
2017-03-07 10:09:00 +01:00
Example [pelicanconf.py ](https://github.com/nairobilug/pelican-alchemy/blob/demo/pelicanconf.py ) (demo website).
2016-12-01 11:22:37 +01:00
2017-03-07 10:09:00 +01:00
## Tips & Tricks
2014-05-28 23:54:52 +02:00
2017-03-07 10:09:00 +01:00
[https://github.com/nairobilug/pelican-alchemy/wiki/Tips ](https://github.com/nairobilug/pelican-alchemy/wiki/Tips )