Go to file

Gilson Filho b5abd59c18 Merge pull request #30 from drgarcia1986/img-auto-resize add image `auto resize` in css files		2016-02-21 21:40:23 -03:00
static	add image `auto resize` in css files	2016-02-14 21:19:35 -02:00
templates	Merge pull request #29 from drgarcia1986/master	2016-02-21 21:38:22 -03:00
.gitignore	Fix static urls	2014-12-10 15:37:34 -02:00
README.md	Merge pull request #26 from pajowu/twitter-cards	2016-02-21 21:37:08 -03:00
screenshot.png	Change screenshot location	2014-12-10 23:00:27 -02:00

README.md

Pelican Clean Blog Theme

Theme based in Clean Blog layout.

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'

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.

External feed URL

You can specify an external feed URL (e.g. FeedBurner) in SOCIAL using the rss or rss-square icons. The icon will be shown in the footer with the rest of your SOCIAL accounts. A tag for the external feed will be placed in <head> instead of the default Pelican feeds.

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.

Twitter cards

Twitter cards are automatically generated if TWITTER_HANDLE is set:

TWITTER_HANDLE = "myprofile"

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