Skip to main content

Shiori theme for Pelican

Project description

pelican-shiori is a port of the Shiori theme (originally built for Jekyll by Elle Kasai) to Pelican.


$ pip install pelican-shiori



In your pelican, set the THEME and ASSET_CONFIG variables like the following -

import pelican_shiori

THEME = pelican_shiori.path()
ASSET_CONFIG = pelican_shiori.asset_config()


The following configuration variables are supported.

  • SHIORI_AVATAR_URL: URL of the avatar you’d like to show on the sidebar

  • SHIORI_HIDE_SIDEBAR: whether or not to show the sidebar

  • SHIORI_INDEX_ARTICLES_COUNT: number of articles to show on the index page

  • SHIORI_THEME: which color scheme to use (one of dark, turquoise, green, blue, purple, orange, red)

Color Schemes

This theme is available in multiple color schemes (based on Flat UI Colors). The default value for the color scheme is set to (surprise) default. To change it to one of the supported values, adjust the SHIORI_THEME and ASSET_CONFIG variables as follows -

ASSET_CONFIG = pelican_shiori.asset_config(SHIORI_THEME)

Please make sure that the argument given to pelican_shiori.asset_config is the same as SHIORI_THEME. Bad things may happen otherwise.

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

pelican_shiori-0.2.1.tar.gz (59.3 kB view hashes)

Uploaded source

Built Distribution

pelican_shiori-0.2.1-py3-none-any.whl (94.2 kB view hashes)

Uploaded py3

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