blog-theme/README.md

# pelican-alchemy

A magical ✨ [Pelican](http://getpelican.com) theme. Inspired by [crowsfoot](http://github.com/porterjamesj/crowsfoot) and [clean-blog](https://github.com/BlackrockDigital/startbootstrap-clean-blog).

Powered by [Bootstrap](https://github.com/twbs/bootstrap) (v3.x).

---

## Screenshot

Live demo: [nairobilug.or.ke](http://nairobilug.or.ke)

![Screenshot](/screenshot.png "Screenshot")

## Installation

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

Then set the pelican config variable `THEME` to the `alchemy` folder inside the cloned path.

### Theme Options

| Config                    | Type       | Description               |
| ------------------------- | ---------- | ------------------------- |
| SITE_TAGLINE              | TEXT       | Site tagline/slogan       |
| SITE_DESCRIPTION          | TEXT       | HEAD meta description     |
| SITE_IMAGE                | URL        | Site (profile) image      |
| SHOW_ARTICLE_AUTHOR       | BOOL       | Show article authors      |
| SHOW_FAVICONS             | BOOL       | Show favicons [^1]        |
| SHOW_FOOTER_ARCHIVES      | BOOL       | Show `Archives` link      |
| SHOW_FOOTER_AUTHORS       | BOOL       | Show `Authors` link       |
| SHOW_FOOTER_CATEGORIES    | BOOL       | Show `Categories` link    |
| SHOW_FOOTER_TAGS          | BOOL       | Show `Tags` link          |
| SHOW_HEADER_PAGES         | BOOL       | Show 'Pages' links        |
| HEADER_LINKS              | LIST       | `('title', 'url')` list   |
| GITHUB_ADDRESS            | URL        | Github link icon          |
| TWITTER_ADDRESS           | URL        | Twitter link icon         |
| GOOGLE_ADDRESS            | URL        | Google+ link icon         |
| EMAIL_ADDRESS             | EMAIL      | Email link (`mailto:`)    |
| FACEBOOK_ADDRESS          | URL        | Facebook link icon        |
| DISQUS_SITENAME           | TEXT       | Disqus comments           |

An RSS icon will also appear on the nav if `FEED_ALL_ATOM` is set.

## License

MIT License

[^1]: http://realfavicongenerator.net "realfavicongenerator.net"
Add README and screenshot 2013-11-25 05:59:15 +01:00			`# pelican-alchemy`

Update theme description 2016-11-08 06:24:42 +01:00			`A magical ✨ [Pelican](http://getpelican.com) theme. Inspired by [crowsfoot](http://github.com/porterjamesj/crowsfoot) and [clean-blog](https://github.com/BlackrockDigital/startbootstrap-clean-blog).`

			`Powered by [Bootstrap](https://github.com/twbs/bootstrap) (v3.x).`

			`---`

			`## Screenshot`
Add README and screenshot 2013-11-25 05:59:15 +01:00
Adjust headings, theme options, format code Update copyright date (2016) Update README Update README Update README 2016-11-06 22:21:36 +01:00			`Live demo: [nairobilug.or.ke](http://nairobilug.or.ke)`
Trivial: format and cleanup 2014-06-21 14:55:27 +02:00
Adjust headings, theme options, format code Update copyright date (2016) Update README Update README Update README 2016-11-06 22:21:36 +01:00			`![Screenshot](/screenshot.png "Screenshot")`
This shit should work now ─────────▄──────────────▄ ────────▌▒█───────────▄▀▒▌ ────────▌▒▒▀▄───────▄▀▒▒▒▐ ───────▐▄▀▒▒▀▀▀▀▄▄▄▀▒▒▒▒▒▐ ─────▄▄▀▒▒▒▒▒▒▒▒▒▒▒█▒▒▄█▒▐ ───▄▀▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▀██▀▒▌ ──▐▒▒▒▄▄▄▒▒▒▒▒▒▒▒▒▒▒▒▒▀▄▒▒▌ ──▌▒▒▐▄█▀▒▒▒▒▄▀█▄▒▒▒▒▒▒▒█▒▐ ─▐▒▒▒▒▒▒▒▒▒▒▒▌██▀▒▒▒▒▒▒▒▒▀▄▌ ─▌▒▀▄██▄▒▒▒▒▒▒▒▒▒▒▒░░░░▒▒▒▒▌ ─▌▀▐▄█▄█▌▄▒▀▒▒ Such commit ▐ ▐▒▀▐▀▐▀▒▒▄▄▒▄▒▒▒▒▒░░░░░░▒▒▒▒▌ ▐▒▒▒▀▀▄▄▒▒▒▄▒▒▒▒▒▒░░░░░░▒▒▒▐ ─▌▒▒▒▒▒▒▀▀▀▒▒▒▒▒▒▒▒ Wow ▒▒▒▌ ─▐▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐ ──▀▄▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▄▒▒▒▒▌ ────▀▄▒▒▒▒▒▒▒▒▒▒▄▄▄▀▒▒▒▒▄▀ ───▐▀▒▀▄▄▄ 2014-05-28 23:54:52 +02:00
			`## Installation`

Adjust headings, theme options, format code Update copyright date (2016) Update README Update README Update README 2016-11-06 22:21:36 +01:00			`$ git clone git@github.com:nairobilug/pelican-alchemy.git`
This shit should work now ─────────▄──────────────▄ ────────▌▒█───────────▄▀▒▌ ────────▌▒▒▀▄───────▄▀▒▒▒▐ ───────▐▄▀▒▒▀▀▀▀▄▄▄▀▒▒▒▒▒▐ ─────▄▄▀▒▒▒▒▒▒▒▒▒▒▒█▒▒▄█▒▐ ───▄▀▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▀██▀▒▌ ──▐▒▒▒▄▄▄▒▒▒▒▒▒▒▒▒▒▒▒▒▀▄▒▒▌ ──▌▒▒▐▄█▀▒▒▒▒▄▀█▄▒▒▒▒▒▒▒█▒▐ ─▐▒▒▒▒▒▒▒▒▒▒▒▌██▀▒▒▒▒▒▒▒▒▀▄▌ ─▌▒▀▄██▄▒▒▒▒▒▒▒▒▒▒▒░░░░▒▒▒▒▌ ─▌▀▐▄█▄█▌▄▒▀▒▒ Such commit ▐ ▐▒▀▐▀▐▀▒▒▄▄▒▄▒▒▒▒▒░░░░░░▒▒▒▒▌ ▐▒▒▒▀▀▄▄▒▒▒▄▒▒▒▒▒▒░░░░░░▒▒▒▐ ─▌▒▒▒▒▒▒▀▀▀▒▒▒▒▒▒▒▒ Wow ▒▒▒▌ ─▐▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐ ──▀▄▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▄▒▒▒▒▌ ────▀▄▒▒▒▒▒▒▒▒▒▒▄▄▄▀▒▒▒▒▄▀ ───▐▀▒▀▄▄▄ 2014-05-28 23:54:52 +02:00
			Then set the pelican config variable `THEME` to the `alchemy` folder inside the cloned path.

Update the readme 2014-05-31 15:35:24 +02:00			`### Theme Options`

Trivial: format and cleanup 2014-06-21 15:16:12 +02:00			`\| Config \| Type \| Description \|`
			`\| ------------------------- \| ---------- \| ------------------------- \|`
Adjust headings, theme options, format code Update copyright date (2016) Update README Update README Update README 2016-11-06 22:21:36 +01:00			`\| SITE_TAGLINE \| TEXT \| Site tagline/slogan \|`
			`\| SITE_DESCRIPTION \| TEXT \| HEAD meta description \|`
			`\| SITE_IMAGE \| URL \| Site (profile) image \|`
			`\| SHOW_ARTICLE_AUTHOR \| BOOL \| Show article authors \|`
			`\| SHOW_FAVICONS \| BOOL \| Show favicons [^1] \|`
			\| SHOW_FOOTER_ARCHIVES \| BOOL \| Show `Archives` link \|
			\| SHOW_FOOTER_AUTHORS \| BOOL \| Show `Authors` link \|
			\| SHOW_FOOTER_CATEGORIES \| BOOL \| Show `Categories` link \|
			\| SHOW_FOOTER_TAGS \| BOOL \| Show `Tags` link \|
			`\| SHOW_HEADER_PAGES \| BOOL \| Show 'Pages' links \|`
			\| HEADER_LINKS \| LIST \| `('title', 'url')` list \|
			`\| GITHUB_ADDRESS \| URL \| Github link icon \|`
			`\| TWITTER_ADDRESS \| URL \| Twitter link icon \|`
			`\| GOOGLE_ADDRESS \| URL \| Google+ link icon \|`
			\| EMAIL_ADDRESS \| EMAIL \| Email link (`mailto:`) \|
			`\| FACEBOOK_ADDRESS \| URL \| Facebook link icon \|`
			`\| DISQUS_SITENAME \| TEXT \| Disqus comments \|`

			An RSS icon will also appear on the nav if `FEED_ALL_ATOM` is set.
Trivial: format and cleanup 2014-06-21 14:55:27 +02:00
This shit should work now ─────────▄──────────────▄ ────────▌▒█───────────▄▀▒▌ ────────▌▒▒▀▄───────▄▀▒▒▒▐ ───────▐▄▀▒▒▀▀▀▀▄▄▄▀▒▒▒▒▒▐ ─────▄▄▀▒▒▒▒▒▒▒▒▒▒▒█▒▒▄█▒▐ ───▄▀▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▀██▀▒▌ ──▐▒▒▒▄▄▄▒▒▒▒▒▒▒▒▒▒▒▒▒▀▄▒▒▌ ──▌▒▒▐▄█▀▒▒▒▒▄▀█▄▒▒▒▒▒▒▒█▒▐ ─▐▒▒▒▒▒▒▒▒▒▒▒▌██▀▒▒▒▒▒▒▒▒▀▄▌ ─▌▒▀▄██▄▒▒▒▒▒▒▒▒▒▒▒░░░░▒▒▒▒▌ ─▌▀▐▄█▄█▌▄▒▀▒▒ Such commit ▐ ▐▒▀▐▀▐▀▒▒▄▄▒▄▒▒▒▒▒░░░░░░▒▒▒▒▌ ▐▒▒▒▀▀▄▄▒▒▒▄▒▒▒▒▒▒░░░░░░▒▒▒▐ ─▌▒▒▒▒▒▒▀▀▀▒▒▒▒▒▒▒▒ Wow ▒▒▒▌ ─▐▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐ ──▀▄▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▄▒▒▒▒▌ ────▀▄▒▒▒▒▒▒▒▒▒▒▄▄▄▀▒▒▒▒▄▀ ───▐▀▒▀▄▄▄ 2014-05-28 23:54:52 +02:00			`## License`

Adjust headings, theme options, format code Update copyright date (2016) Update README Update README Update README 2016-11-06 22:21:36 +01:00			`MIT License`
Add EXTRA_FAVICON option http://realfavicongenerator.net/faq#why_so_many_files 2014-06-21 14:40:42 +02:00
Adjust headings, theme options, format code Update copyright date (2016) Update README Update README Update README 2016-11-06 22:21:36 +01:00			`[^1]: http://realfavicongenerator.net "realfavicongenerator.net"`