Skip to content

Latest commit

 

History

History
164 lines (121 loc) · 4.08 KB

README.md

File metadata and controls

164 lines (121 loc) · 4.08 KB
Raw

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:[email protected]'))

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.

User defined footer

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__)]

WARNING: avoid using names which duplicate existing templates from the theme directory, for example footer.html. Due to how Pelican searches the template directories it will first find the files in the theme directory and you will not see the desired results.

Analytics

Accept many analytics:

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

Other configuration

  • If ADDTHIS_PUBID is defined sharing buttons from AddThis will appear at the bottom of the article;
  • GOOGLE_SITE_VERIFICATION - Google site verification token;
  • 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 <title> HTML tag;

Articles

To customize header cover to articles, insert the metadata header_cover:

  • To RST
My super title
##############

:date: 2010-10-03 10:20
:modified: 2010-10-04 18:40
:tags: thats, awesome
:category: yeah
:slug: my-super-post
:authors: Alexis Metaireau, Conan Doyle
:summary: Short version for index and feeds
:header_cover: /images/posts/super-title/cover.png
  • To Markdown
Title: My super title
Date: 2010-12-03 10:20
Modified: 2010-12-05 19:30
Category: Python
Tags: pelican, publishing
Slug: my-super-post
Authors: Alexis Metaireau, Conan Doyle
Summary: Short version for index and feeds
Header_Cover: /images/posts/super-title/cover.png

This is the content of my super blog post.

Other metada was created to assign resume of article, with headline:

  • To RST
My super title
##############

:date: 2010-10-03 10:20
:modified: 2010-10-04 18:40
:tags: thats, awesome
:category: yeah
:slug: my-super-post
:authors: Alexis Metaireau, Conan Doyle
:summary: Short version for index and feeds
:headline: Resume of article
  • To Markdown
Title: My super title
Date: 2010-12-03 10:20
Modified: 2010-12-05 19:30
Category: Python
Tags: pelican, publishing
Slug: my-super-post
Authors: Alexis Metaireau, Conan Doyle
Summary: Short version for index and feeds
Headline: Resume of article

This is the content of my super blog post.