Plumage

Plumage is a theme for Pelican, a static site generator written in Python.

I initially created this theme for my blog, but now the theme is supposed to be generic enough to have its own repository.

Features

• Based on Bootstrap v3.
• Solarized code snippets via Pygments for syntax highlighting.
• Site-wide static search via Tipue-search.
• Project template.
• Tags grouped by tiers.
• External assets (Bootstrap, Jquery, etc...) uses CDNjs .
• YouTube links.
• Direct link to edit articles on Github.

Plugins

Plumage has built-in support for the following plugins:

• tipue_search
• neighbors
• related_posts
• typogrify

Installation

This package is available on PyPi, so you can install the latest stable release and its dependencies with a simple pip call:

$ pip install plumage

Then, update your pelicanconf.py file, with the module:

import plumage

THEME = plumage.get_path()

Settings

Plumage can be customized by adding these optionnal parameters to your pelicanconf.py file:

Most of these parameters are similar to notmyidea's (Pelican's default theme). For usage example, please have a look into my own pelicanconf.py .

The theme is also sensible to this list of standard Pelican parameters :

• ARCHIVES_SAVE_AS
• AUTHOR
• AUTHOR_SAVE_AS
• AUTHORS_SAVE_AS
• CATEGORIES_SAVE_AS
• CATEGORY_FEED_ATOM
• CATEGORY_FEED_RSS
• DEFAULT_LANG
• DEFAULT_PAGINATION
• DISPLAY_PAGES_ON_MENU
• DISPLAY_CATEGORIES_ON_MENU
• FEED_ALL_ATOM
• FEED_ALL_RSS
• FEED_ATOM
• FEED_DOMAIN
• FEED_RSS
• PAGINATION_PATTERNS
• SITENAME
• SITEURL
• TAG_FEED_ATOM
• TAG_FEED_RSS
• TAGS_SAVE_AS
• TYPOGRIFY

Common pitfalls

Some plugins may need additional settings, for instance for tipue_search, after applying the standard options:

PLUGINS = ['tipue_search']
TIPUE_SEARCH = True

... you'll need to declare additional template file, by either adding this line to your pelicanconf.py:

TEMPLATE_PAGES = {
        'search.html': 'search.html',
        }

or using this technique.

FAQ

How can I disable the zoom on images?

All images of an article are zoomable by default. You can deactivate the magnifying glass per-image by adding a noZoom CSS class. So instead of the following Markdown code:

![Image title](/folder/image.png)

You have to use the following template to deactivate the zoom of an image:

![Image title](/folder/image.png){: .noZoom}

License

This software is licensed under the GNU General Public License v2 or later (GPLv2+).

Copyright (C) 2012-2017 Kevin Deldycke and contributors. All Rights Reserved.

Third-party assets

The theme uses external softwares, scripts, libraries and artworks:

jQuery MGlass v1.1
Copyright (c) 2012 Younès El Biache
Distributed under a MIT license
Source: https://github.com/younes0/jQuery-MGlass

Solarized Pygment style v0.1.0
Copyright (c) 2012 Shoji KUMAGAI
Distributed under a MIT license
Source: https://pypi.python.org/pypi/pygments-style-solarized

Fabric (Plaid)
Copyright (c) 2012 James Basoo
Distributed under a Creative Commons Attribution-ShareAlike 3.0 Unported license
Source: https://subtlepatterns.com/fabric-plaid/

Cream paper
Copyright (c) 2012 Devin Holmes
Distributed under a Creative Commons Attribution-ShareAlike 3.0 Unported license
Source: https://subtlepatterns.com/cream-paper/