blog-theme/README.md

# pelican-alchemy

A theme for the [Pelican](http://getpelican.com) static site generator. A shameless rip off of @porterjamesj's [crowsfoot](http://github.com/porterjamesj/crowsfoot) theme.


## Screenshot

![pelican-alchemy](screenshot.png)


## 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.


## Usage

Pelican [documentation](http://docs.getpelican.com/en/latest/)


### Theme Options

| Config                    | Type       | Description               |
| ------------------------- | ---------- | ------------------------- |
| EXTRA_FAVICON [^1]        | BOOL       | Extra favicons            |
| LICENSE_NAME              | TEXT       | License (footer)          |
| LICENSE_URL               | URL        | -                         |
| MENU_ITEMS                | DICT       | Menu items                |
| META_DESCRIPTION          | TEXT       | Meta description          |
| PAGES_ON_MENU             | BOOL       | Pages on the menu         |
| CATEGORIES_ON_MENU        | BOOL       | Category link in menu     |
| TAGS_ON_MENU              | BOOL       | Tag link in menu          |
| ARCHIVES_ON_MENU          | BOOL       | Archives link in menu     |
| PROFILE_IMAGE             | URL        | Profile image             |
| SHOW_ARTICLE_AUTHOR       | BOOL       | Show/hide author          |
| SITE_SUBTEXT              | TEXT       | Header subtitle           |

| Config                    | Type       | Description               |
| ------------------------- | ---------- | ------------------------- |
| EMAIL_ADDRESS             | EMAIL      | Email (mailto)            |
| FB_ADDRESS                | URL        | Facebook                  |
| GITHUB_ADDRESS            | URL        | Github                    |
| SO_ADDRESS                | URL        | Stack Overflow            |
| TWITTER_ADDRESS           | URL        | Twitter                   |

An RSS icon will also appear on the nav if `FEED_ATOM` or `FEED_RSS` is set.

| Config                    | Type       | Description               |
| ------------------------- | ---------- | ------------------------- |
| DISQUS_SITENAME           | TEXT       | Disqus sitename           |
| GOOGLE_ANALYTICS_DOMAIN   | TEXT       | Google analytics          |
| GOOGLE_ANALYTICS_ID       | TEXT       | Google analytics          |


## Live Demo

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


## License

MIT


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

Update readme 2014-05-31 16:17:59 +02:00			`A theme for the [Pelican](http://getpelican.com) static site generator. A shameless rip off of @porterjamesj's [crowsfoot](http://github.com/porterjamesj/crowsfoot) theme.`
Add README and screenshot 2013-11-25 05:59:15 +01:00
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			`## Screenshot`
Add README and screenshot 2013-11-25 05:59:15 +01:00
Use relative links 2014-05-29 12:17:08 +02:00			`![pelican-alchemy](screenshot.png)`
This shit should work now ─────────▄──────────────▄ ────────▌▒█───────────▄▀▒▌ ────────▌▒▒▀▄───────▄▀▒▒▒▐ ───────▐▄▀▒▒▀▀▀▀▄▄▄▀▒▒▒▒▒▐ ─────▄▄▀▒▒▒▒▒▒▒▒▒▒▒█▒▒▄█▒▐ ───▄▀▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▀██▀▒▌ ──▐▒▒▒▄▄▄▒▒▒▒▒▒▒▒▒▒▒▒▒▀▄▒▒▌ ──▌▒▒▐▄█▀▒▒▒▒▄▀█▄▒▒▒▒▒▒▒█▒▐ ─▐▒▒▒▒▒▒▒▒▒▒▒▌██▀▒▒▒▒▒▒▒▒▀▄▌ ─▌▒▀▄██▄▒▒▒▒▒▒▒▒▒▒▒░░░░▒▒▒▒▌ ─▌▀▐▄█▄█▌▄▒▀▒▒ Such commit ▐ ▐▒▀▐▀▐▀▒▒▄▄▒▄▒▒▒▒▒░░░░░░▒▒▒▒▌ ▐▒▒▒▀▀▄▄▒▒▒▄▒▒▒▒▒▒░░░░░░▒▒▒▐ ─▌▒▒▒▒▒▒▀▀▀▒▒▒▒▒▒▒▒ Wow ▒▒▒▌ ─▐▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐ ──▀▄▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▄▒▒▒▒▌ ────▀▄▒▒▒▒▒▒▒▒▒▒▄▄▄▀▒▒▒▒▄▀ ───▐▀▒▀▄▄▄ 2014-05-28 23:54:52 +02:00
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			`## Installation`

Trivial: format and cleanup 2014-06-21 15:31:30 +02: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.

Trivial: format and cleanup 2014-06-21 14:55:27 +02:00
Tidy up 2014-05-28 23:56:41 +02:00			`## Usage`
This shit should work now ─────────▄──────────────▄ ────────▌▒█───────────▄▀▒▌ ────────▌▒▒▀▄───────▄▀▒▒▒▐ ───────▐▄▀▒▒▀▀▀▀▄▄▄▀▒▒▒▒▒▐ ─────▄▄▀▒▒▒▒▒▒▒▒▒▒▒█▒▒▄█▒▐ ───▄▀▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▀██▀▒▌ ──▐▒▒▒▄▄▄▒▒▒▒▒▒▒▒▒▒▒▒▒▀▄▒▒▌ ──▌▒▒▐▄█▀▒▒▒▒▄▀█▄▒▒▒▒▒▒▒█▒▐ ─▐▒▒▒▒▒▒▒▒▒▒▒▌██▀▒▒▒▒▒▒▒▒▀▄▌ ─▌▒▀▄██▄▒▒▒▒▒▒▒▒▒▒▒░░░░▒▒▒▒▌ ─▌▀▐▄█▄█▌▄▒▀▒▒ Such commit ▐ ▐▒▀▐▀▐▀▒▒▄▄▒▄▒▒▒▒▒░░░░░░▒▒▒▒▌ ▐▒▒▒▀▀▄▄▒▒▒▄▒▒▒▒▒▒░░░░░░▒▒▒▐ ─▌▒▒▒▒▒▒▀▀▀▒▒▒▒▒▒▒▒ Wow ▒▒▒▌ ─▐▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐ ──▀▄▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▄▒▒▒▒▌ ────▀▄▒▒▒▒▒▒▒▒▒▒▄▄▄▀▒▒▒▒▄▀ ───▐▀▒▀▄▄▄ 2014-05-28 23:54:52 +02:00
Update the readme 2014-05-31 15:35:24 +02:00			`Pelican [documentation](http://docs.getpelican.com/en/latest/)`

Trivial: format and cleanup 2014-06-21 14:55:27 +02:00
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 \|`
			`\| ------------------------- \| ---------- \| ------------------------- \|`
Add EXTRA_FAVICON option http://realfavicongenerator.net/faq#why_so_many_files 2014-06-21 14:40:42 +02:00			`\| EXTRA_FAVICON [^1] \| BOOL \| Extra favicons \|`
Trivial: format and cleanup 2014-06-21 15:16:12 +02:00			`\| LICENSE_NAME \| TEXT \| License (footer) \|`
			`\| LICENSE_URL \| URL \| - \|`
			`\| MENU_ITEMS \| DICT \| Menu items \|`
Add META_DESCRIPTION option 2014-06-21 13:07:58 +02:00			`\| META_DESCRIPTION \| TEXT \| Meta description \|`
Add PAGES_ON_MENU option 2014-06-21 13:05:45 +02:00			`\| PAGES_ON_MENU \| BOOL \| Pages on the menu \|`
introduce options for category, tag and archives links on menu 2015-04-10 21:21:20 +02:00			`\| CATEGORIES_ON_MENU \| BOOL \| Category link in menu \|`
			`\| TAGS_ON_MENU \| BOOL \| Tag link in menu \|`
			`\| ARCHIVES_ON_MENU \| BOOL \| Archives link in menu \|`
Trivial: format and cleanup 2014-06-21 15:16:12 +02:00			`\| PROFILE_IMAGE \| URL \| Profile image \|`
			`\| SHOW_ARTICLE_AUTHOR \| BOOL \| Show/hide author \|`
			`\| SITE_SUBTEXT \| TEXT \| Header subtitle \|`

			`\| Config \| Type \| Description \|`
			`\| ------------------------- \| ---------- \| ------------------------- \|`
			`\| EMAIL_ADDRESS \| EMAIL \| Email (mailto) \|`
			`\| FB_ADDRESS \| URL \| Facebook \|`
			`\| GITHUB_ADDRESS \| URL \| Github \|`
			`\| SO_ADDRESS \| URL \| Stack Overflow \|`
			`\| TWITTER_ADDRESS \| URL \| Twitter \|`
Update the readme 2014-05-31 15:35:24 +02:00
			An RSS icon will also appear on the nav if `FEED_ATOM` or `FEED_RSS` is set.

Trivial: format and cleanup 2014-06-21 15:16:12 +02:00			`\| Config \| Type \| Description \|`
			`\| ------------------------- \| ---------- \| ------------------------- \|`
			`\| DISQUS_SITENAME \| TEXT \| Disqus sitename \|`
			`\| GOOGLE_ANALYTICS_DOMAIN \| TEXT \| Google analytics \|`
			`\| GOOGLE_ANALYTICS_ID \| TEXT \| Google analytics \|`
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
			`## Live Demo`

Tidy up 2014-05-28 23:56:41 +02:00			`[nairobilug.or.ke](http://nairobilug.or.ke)`
This shit should work now ─────────▄──────────────▄ ────────▌▒█───────────▄▀▒▌ ────────▌▒▒▀▄───────▄▀▒▒▒▐ ───────▐▄▀▒▒▀▀▀▀▄▄▄▀▒▒▒▒▒▐ ─────▄▄▀▒▒▒▒▒▒▒▒▒▒▒█▒▒▄█▒▐ ───▄▀▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▀██▀▒▌ ──▐▒▒▒▄▄▄▒▒▒▒▒▒▒▒▒▒▒▒▒▀▄▒▒▌ ──▌▒▒▐▄█▀▒▒▒▒▄▀█▄▒▒▒▒▒▒▒█▒▐ ─▐▒▒▒▒▒▒▒▒▒▒▒▌██▀▒▒▒▒▒▒▒▒▀▄▌ ─▌▒▀▄██▄▒▒▒▒▒▒▒▒▒▒▒░░░░▒▒▒▒▌ ─▌▀▐▄█▄█▌▄▒▀▒▒ Such commit ▐ ▐▒▀▐▀▐▀▒▒▄▄▒▄▒▒▒▒▒░░░░░░▒▒▒▒▌ ▐▒▒▒▀▀▄▄▒▒▒▄▒▒▒▒▒▒░░░░░░▒▒▒▐ ─▌▒▒▒▒▒▒▀▀▀▒▒▒▒▒▒▒▒ Wow ▒▒▒▌ ─▐▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▐ ──▀▄▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▄▒▒▒▒▌ ────▀▄▒▒▒▒▒▒▒▒▒▒▄▄▄▀▒▒▒▒▄▀ ───▐▀▒▀▄▄▄ 2014-05-28 23:54:52 +02:00
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`

			`MIT`
Add EXTRA_FAVICON option http://realfavicongenerator.net/faq#why_so_many_files 2014-06-21 14:40:42 +02:00

			`[^1]: http://realfavicongenerator.net/faq#why_so_many_files "Why so many files?"`