pelican-clean-blog/README.md

3.7 KiB

Pelican Clean Blog Theme

Theme based in Clean Blog layout.

Screenshot

Screenshot

Basic configuration

All configurations about this theme.

Header Covers

To define custom header cover, set the property HEADER_COVER in pelicanconf.py:

HEADER_COVER = 'static/my_image.png'

Social URLs

Github, Twitter and Facebook URLs set these properties:

SOCIAL = (('twitter', 'https://twitter.com/myprofile'),
          ('github', 'https://github.com/myprofile'),
          ('facebook','https://facebook.com/myprofile'),
          ('flickr','https://www.flickr.com/myprofile/'),
          ('envelope','mailto:my@mail.address'))

If you have new links add them to SOCIAL. The Name has to be the name of the corresponding FontAwesome icon.

Code highlights

This theme contains this color schemes:

  • Tomorrow - tomorrow.css;
  • Tomorrow Night - tomorrow_night.css;
  • Monokai - monokai.css;
  • Github - github.css;
  • Darkly (Default) - darkly.css;

To customize, define COLOR_SCHEME_CSS in pelicanconf.py with css filename. Example:

COLOR_SCHEME_CSS = 'monokai.css'

User defined CSS

Define CSS_OVERRIDE in pelicanconf.py to insert a user defined CSS file after theme CSS. Example:

CSS_OVERRIDE = 'myblog.css'

Disable theme JavaScript

Set DISABLE_CUSTOM_THEME_JAVASCRIPT to True if you want to disable js/clean-blog.min.js in case it affects forms and input fields.

Define FOOTER_INCLUDE in pelicanconf.py to insert a custom footer text instead the default "Powered by Pelican". The value is a template path. You also need to define the EXTRA_TEMPLATES_PATHS setting. Example:

FOOTER_INCLUDE = 'myfooter.html'
EXTRA_TEMPLATES_PATHS = [os.path.dirname(__file__)]

Analytics

Accept many analytics:

  • Google Analytics: GOOGLE_ANALYTICS;
  • Gauges: GAUGES
  • Piwik: PIWIK_URL and PIWIK_SITE_ID.

Other configuration

  • Set SHOW_FULL_ARTICLE to True to show full article content on index.html instead of summary;
  • Set SHOW_SITESUBTITLE_IN_HTML to True to make use of the SITESUBTITLE variable inside the