Variables

Pelican Variables

Pelican ?

Display pages on the menu of the template

DISPLAY_PAGES_ON_MENU               = True

Display categories on the menu

DISPLAY_CATEGORIES_ON_MENU          = False

Your social links

SOCIAL                              = (('twitter', 'http://twitter.com/DaanDebie'),
                                       ('linkedin', 'http://www.linkedin.com/in/danieldebie'),
                                       ('github', 'http://github.com/DandyDev'),
                                       ('stackoverflow', 'http://stackoverflow.com/users/872397/dandydev', 'stack-overflow'))

list of directories or files to be added to the output directory.

STATIC_PATHS                        = ['images']

Path to your pelican-bootstrap3 theme.

THEME                               = ''

RAW Text or HTML used in footer

AUTHOR                              = ''

Alternative to add a static file or folder

EXTRA_PATH_METADATA                 = {}
# Example:
# EXTRA_PATH_METADATA = {
# 'precompiled/path/to/file': {'path': 'generated/path'},
# 'precompiled/path/to/folder': {'path': 'generated/folder'}
# }

Relative URL to output the all-posts Atom feed

FEED_ALL_ATOM                       = 'feeds/all.atom.xml'

Relative URL to output the all-posts RSS feed

FEED_ALL_RSS                        = ''

Extra menu items to appear at the beginning of the main menu

MENUITEMS                           = ()

Your site name

SITENAME                            = ''

DISQUS

####Set to True to show comment count. DISQUS_DISPLAY_COUNTS = False

####Set to true if slug is not unique. DISQUS_ID_PREFIX_SLUG = False

Whether to generate a unique ID or not ?

DISQUS_NO_ID                        = False

####Specify the Disqus sitename identifier here DISQUS_SITENAME = ''

PIWIK

PIWIK - Website ID

PIWIK_SITE_ID                       = ''

PIWIK - If SSL URL differs

PIWIK_SSL_URL                       = ''

PIWIK - URL to your PIWIK server

PIWIK_URL                           = ''

pelican-bootstrap3 Variables

General

Which Bootswatch theme to use

BOOTSTRAP_THEME                     = ''
# BOOTSTRAP_THEME                   = 'cerulean'
# BOOTSTRAP_THEME                   = 'cosmo'
# BOOTSTRAP_THEME                   = 'cyborg'
# BOOTSTRAP_THEME                   = 'darkly'
# BOOTSTRAP_THEME                   = 'flatly'
# BOOTSTRAP_THEME                   = 'journal'
# BOOTSTRAP_THEME                   = 'lumen'
# BOOTSTRAP_THEME                   = 'paper'
# BOOTSTRAP_THEME                   = 'readable'
# BOOTSTRAP_THEME                   = 'sandstone'
# BOOTSTRAP_THEME                   = 'simplex'
# BOOTSTRAP_THEME                   = 'slate'
# BOOTSTRAP_THEME                   = 'spacelab'
# BOOTSTRAP_THEME                   = 'superhero'
# BOOTSTRAP_THEME                   = 'united'
# BOOTSTRAP_THEME                   = 'yeti

Set the syntax highlight theme

PYGMENTS_STYLE                      = 'native'
# PYGMENTS_STYLE                    = "autumn"
# PYGMENTS_STYLE                    = "borland"
# PYGMENTS_STYLE                    = "bw"
# PYGMENTS_STYLE                    = "colorful"
# PYGMENTS_STYLE                    = "default"
# PYGMENTS_STYLE                    = "emacs"
# PYGMENTS_STYLE                    = "friendly"
# PYGMENTS_STYLE                    = "fruity"
# PYGMENTS_STYLE                    = "manni"
# PYGMENTS_STYLE                    = "monokai"
# PYGMENTS_STYLE                    = "murphy"
# PYGMENTS_STYLE                    = "native"
# PYGMENTS_STYLE                    = "pastie"
# PYGMENTS_STYLE                    = "perldoc"
# PYGMENTS_STYLE                    = "solarizeddark"
# PYGMENTS_STYLE                    = "solarizedlight"
# PYGMENTS_STYLE                    = "tango"
# PYGMENTS_STYLE                    = "trac"
# PYGMENTS_STYLE                    = "vim"
# PYGMENTS_STYLE                    = "vs"
# PYGMENTS_STYLE                    = "zenburn"

Use Bootstrap 3 pagination

USE_PAGER                           = False

Show banner in all pages?

BANNER_ALL_PAGES                    = False

Set the banner subtitle. RAW Text or HTML

BANNER_SUBTITLE                     = ''

Set your banner. Can be relative or absolute

BANNER                              = ''

Set the fluid container layout from Bootstrap

BOOTSTRAP_FLUID                     = False

Use the inverse navbar from Bootstrap

BOOTSTRAP_NAVBAR_INVERSE            = False

Set the width of the logo

SITELOGO_SIZE                       = ''

Set to True to remove the sidebar

HIDE_SIDEBAR                        = False

Set to True to remove the site name

HIDE_SITENAME                       = False

If True, date/tags/etc will be shown for each article in the index.

DISPLAY_ARTICLE_INFO_ON_INDEX       = False

Show breadcrumbs on site

DISPLAY_BREADCRUMBS                 = False

Display categories on the sidebar

DISPLAY_CATEGORIES_ON_SIDEBAR       = False

Display categories in the breadcrumbs

DISPLAY_CATEGORY_IN_BREADCRUMBS     = False

Show the author of the article at the top of the article and in the index of articles

SHOW_ARTICLE_AUTHOR                 = False

Show the Category of each article

SHOW_ARTICLE_CATEGORY               = False

Show the article modified date next to the published date

SHOW_DATE_MODIFIED                  = False

Amount of recents posts on sidebar. Depends on DISPLAY_RECENT_POSTS_ON_SIDEBAR

RECENT_POST_COUNT                   = 5

Include images on the sidebar. Set a list of links, relative or absolute, to the images.

SIDEBAR_IMAGES                      = ['',]

Site logo

SITELOGO                            = ''

Path to your favicon. Can be relative or absolute

FAVICON                             = ''

If True, include extra CSS styles for reStructuredText

DOCUTIL_CSS                         = False

Path to your image. Can be relative or absolute

AVATAR                              = ''

RAW Text or HTML

ABOUT_ME                            = ''

Path to where the custom css file will be once generated. See STATIC_PATHS and EXTRA_PATH_METADATA

CUSTOM_CSS                          = ''
# Example: '/static/custom.css'

Github

Show this many repositories

GITHUB_REPO_COUNT                   = 5

Set to true to show Github link.

GITHUB_SHOW_USER_LINK               = False

Skip Github Forks

GITHUB_SKIP_FORK                    = False

Set to your Github user

GITHUB_USER                         = ''

AddThis

Disable hashtag in URL used to count times copied

ADDTHIS_DATA_TRACK_ADDRESSBAR       = True

Dislay Facebook under post

ADDTHIS_FACEBOOK_LIKE               = True

Dislay G+ share under post

ADDTHIS_GOOGLE_PLUSONE              = True

Set to your AddThis Profile ID

ADDTHIS_PROFILE                     = ''

AddThis Plugin - Dislay Twitter share under post

ADDTHIS_TWEET                       = True

Twitter

Twitter - Enable Summary Twitter Cards. Needs `USE_OPEN_GRAPH = True` (which is the default).

TWITTER_CARDS                       = False

Twitter - Set the Twitter username

TWITTER_USERNAME                    = ''

Twitter - Set to the widget ID to show timeline in sidebar

TWITTER_WIDGET_ID                   = ''

Facebook

Set to false to disable

USE_OPEN_GRAPH                      = True

Set to Facebook APP ID

OPEN_GRAPH_FB_APP_ID                = ''

Relative file path

OPEN_GRAPH_IMAGE                    = ''

Shariff

Set to True to enable Shariff social media buttons

SHARIFF                             = False

Set to your Shariff instance ?

SHARIFF_BACKEND_URL                 = ''

The localisation to use (en, es, de, etc) ?

SHARIFF_LANG                        = 'de'

How to stack the buttons.

SHARIFF_ORIENTATION                 = 'horizontal'

JSON containing service names to be enabled

SHARIFF_SERVICES                    = '[&quot;facebook&quot;,&quot;googleplus&quot;]'

Color scheme grey and white are alternatives.

SHARIFF_THEME                       = 'standard'

Username to attribute the Tweet to

SHARIFF_TWITTER_VIA                 = False

Content License

Include attribution markup

CC_ATTR_MARKUP                      = False

Set to the common abbreviation of the license you want

CC_LICENSE                          = ''

Set to 'yes' if commercial reuse is permitted

CC_LICENSE_COMMERCIAL               = 'no'

Set to 'yes' if Derivatives are allowed

CC_LICENSE_DERIVATIVES              = 'no'

Set a license string that will be showed at the bottom of every page

CUSTOM_LICENSE                      = ''

Google Analytics

Set to ‘UA-XXXX-YYYY’ to activate

GOOGLE_ANALYTICS                    = ''

More info

GOOGLE_ANALYTICS_UNIVERSAL          = ''