Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Shiori theme for Pelican

Project description

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

Installation

$ pip install pelican-shiori

Requirements

Usage

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

import pelican_shiori

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

Configuration

The following configuration variables are supported.

  • SHIORI_THEME: which color scheme to use (one of dark, turquoise, green, blue, purple, orange, red)
  • SHIORI_HIDE_SIDEBAR: whether or not to show the sidebar
  • SHIORI_INDEX_ARTICLES_COUNT: number of articles to show on the index page

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 -

SHIORI_THEME = 'blue'
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


Release history Release notifications

History Node

0.2.1

History Node

0.2.0

This version
History Node

0.1.1

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pelican_shiori-0.1.1-py3-none-any.whl (94.0 kB) Copy SHA256 hash SHA256 Wheel py3 Dec 7, 2017
pelican_shiori-0.1.1.tar.gz (59.1 kB) Copy SHA256 hash SHA256 Source None Dec 7, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page