peterdesmet / spoonbill

Theme for a Pelican powered blog
Other
3 stars 0 forks source link
pelican pelican-theme theme

Spoonbill

Introduction

Spoonbill is a theme for Pelican powered blogs. I use it for my own blog and it was inspired by Zach Holman's blog.

screenshot

Installation

These instructions assume you have completed the Getting Started guide and have a working Pelican site.

  1. Clone or download the Spoonbill theme and move it to the directory of your choice, e.g. ~/my-themes/spoonbill.

  2. Generate your site from the command line, with the -t option for themes. For example:

    pelican ~/my-site/content -s ~/my-site/content/settings.py -t ~/my-themes/spoonbill
  3. Your spoonbilled site is now available in the output directory.

  4. If you like it, add a link to the Spoonbill directory in your Pelican settings file, so you won't need to specify the theme each time you generate the site. For example:

    THEME = "~/my-themes/spoonbill"

For more options, see the Pelican documentation regarding theme settings.

Settings

Spoonbill has some custom Pelican setting identifiers. Don't forget to include them in your settings file.

SITEDESCRIPTION = "Site description for in description meta tag"
GOOGLE_WEBMASTER = "Google Webmasters Tools verification code"
TWITTER_URL = "URL to your Twitter account (used in footer)"

Dependencies

Spoonbill is based on html5boilerplate. The following default files are included, but not activated: js/main.js, js/plugins.js, js/vendor/jquery-1.9.1.min.js (see at the end of base.html).

Limitations

Translations are not supported.

Alternatives

There are a whole bunch of Pelican themes available on GitHub.

How to contribute

Feel free to fork this repo. If you want to contribute something back, send a pull request. I'm always happy to get feedback.

License

See LICENSE file.