A very simple template for pelican
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
static/css
templates
LICENSE
README.md

README.md

Modest

A simple Pelican theme that that attempts to integrate opengraph and schema.org tags as well as having an easy to read experience.

Pelican Properties

TWITTER_USERNAME: Used to toggle information that is twitter specific.

GITHUB_USERNAME: Used to help with indeweb logins when twitter is not available

FACEBOOK_PROFILES_URL: Used to toggle information that facebook might need.

FACEBOOK_APPID: If you have an AppID from facebook.

DISQUS_SITENAME: To allow chat on the site.

WEBMENTION: To allow the site to have webmentions. Set to url of address (example: mandarismoore.com)

EXTRA_PATH_METADATA

I use the following to make sure that all my icons are placed where I'm expecting.

EXTRA_PATH_METADATA = {'extra/favicon.png': {'path': 'favicon.png'},
                       'extra/apple-touch-icon.png': {'path': 'apple-touch-icon.png'},
                       'extra/apple-touch-icon-precomposed.png': {'path': 'apple-touch-icon-precomposed.png'},
                       'extra/favicon.ico': {'path': 'favicon.ico'},}

Pelican Plugins

This theme relies on the pelican-open_graph plugin. There are other kinds out there but I've been using this one for years.

Recommended Python-Markdown Extensions

This theme uses two markdown extensions to format the raw text into html. These need to be installed into your environment by downloading and then running the python setup.py install command.

figureAltCaption

I use this to make standalone images into figures. You can read about my set up here. As of this writing, I've still have a pull request to allow reference links.

Link: https://github.com/jdittrich/figureAltCaption

TOC

Python-Markdown has a built in feature for making a Table of Contents and making sure that the text being generated has the correct heading levels.

Excerpt from pelicanconfig.py

This is what I have in my config file to control the markdown generation.

MARKDOWN = {
    'extension_configs': {
        'markdown.extensions.codehilite': {'css_class': 'highlight'},
        'markdown.extensions.extra': {},
        'markdown.extensions.meta': {},
        'markdown.extensions.toc': {'baseheader': '3', 'title': 'Table of Contents'}
        'figureAltCaption':{},
    },
    'output_format': 'html5',
}