Skip to main content

Pelican theme, first used for Minchin.ca.

Project description

Seafoam Logo

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

The seafoam theme is based on Bootstrap 3, and was first used at Minchin.ca.

Installation

The easiest way to install the seafoam theme is through the use of pip. This will also install the required dependencies automatically.

pip install seafoam

Then, in your pelicanconf.py file, import the module, use the built in function to specify your theme location, set the default colour scheme (more options coming soon), add the required plugins, and set the image processing patterns used:

import seafoam

THEME = seafoam.get_path()
BOOTSTRAP_THEME = 'seafoam'

PLUGINS = ['minchin.pelican.jinja_filters',
           'minchin.pelican.plugins.image_process',
           # others, as desired...
           ]

IMAGE_PROCESS = {
  'article-feature': ["scale_in 848 848 True"],
  'index-feature': ["scale_in 263 263 True"],
}

# the rest of the your configuration file...

You will may also need to configure the theme through the use of additional settings (see below).

Requirements

Seafoam requires Pelican and the image_process and the jinja filters plugin. If the theme is installed from pip, these should be automatically installed. If needed they can be manually installed with pip:

pip install pelican
pip install minchin.pelican.plugins.image_process
pip install minchin.pelican.jinja_filters

Supported Plugins

Seafoam works with several other plugins for Pelican, but none of those listed in this section are required.

  • readtime – provides estimated reading time for articles. Available from PyPI as pelican-readtime.

  • post-stats – provides estimated reading time for articles if readtime is not available. Available in the Pelican Plugins collection.

  • neigbours – provides post-article links to the next and previous article on your blog and the next and previous article in that category. Available on PyPI as pelican-neighours.

  • pelican_comment_system – add static comments to your blog. Available in the Pelican Plugins collection.

Additional Settings

Details coming. In the meantime, refer to the settings on the Bootstrap 3 theme.

Credits

Original theme developed by Daan Debie.

The idea that a theme could be installed as a Python package by Jeff Forcier’s Alabaster theme for Sphinx.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

seafoam-2.1.0.tar.gz (1.4 MB view hashes)

Uploaded Source

Built Distribution

seafoam-2.1.0-py3-none-any.whl (1.4 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page