Metadata-Version: 2.0
Name: pelican-shiori
Version: 0.2.0
Summary: Shiori theme for Pelican
Home-page: https://github.com/siddhantgoel/pelican-shiori
Author: Siddhant Goel
Author-email: siddhantgoel@gmail.com
License: MIT
Description-Content-Type: UNKNOWN
Keywords: python pelican pelican-theme static-site
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Pelican :: Themes
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: cssmin
Requires-Dist: jinja2
Requires-Dist: webassets


pelican-shiori
==============

.. image:: https://badge.fury.io/py/pelican-shiori.svg
    :target: https://pypi.python.org/pypi/pelican-shiori

:code:`pelican-shiori` is a port of the Shiori_ theme (originally built for
Jekyll by `Elle Kasai`_) to Pelican_.

Installation
------------

.. code-block:: bash

    $ pip install pelican-shiori

Requirements
------------

- assets_ plugin for Pelican
- working SASS_ compiler

Usage
-----

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

.. code-block:: python

    import pelican_shiori

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

Configuration
-------------

The following configuration variables are supported.

- :code:`SHIORI_AVATAR_URL`: URL of the avatar you'd like to show on the sidebar
- :code:`SHIORI_HIDE_SIDEBAR`: whether or not to show the sidebar
- :code:`SHIORI_INDEX_ARTICLES_COUNT`: number of articles to show on the index page
- :code:`SHIORI_THEME`: which color scheme to use (one of :code:`dark`,
  :code:`turquoise`, :code:`green`, :code:`blue`, :code:`purple`,
  :code:`orange`, :code:`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) :code:`default`. To
change it to one of the supported values, adjust the :code:`SHIORI_THEME` and
:code:`ASSET_CONFIG` variables as follows -

.. code-block:: python

    SHIORI_THEME = 'blue'
    ASSET_CONFIG = pelican_shiori.asset_config(SHIORI_THEME)

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

.. _assets: https://github.com/getpelican/pelican-plugins/tree/master/assets
.. _Bad things: https://www.xkcd.com/292
.. _Elle Kasai: http://ellekasai.com
.. _Flat UI Colors: http://flatuicolors.com
.. _Pelican: https://blog.getpelican.com
.. _SASS: http://sass-lang.com/install
.. _Shiori: https://ellekasai.github.io/shiori


