Skip to content

mnrtks/pelican-bootstrap3

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pelican-bootstrap3

This is a Bootstrap 3 theme for Pelican. It's fully responsive. Bootstrap 3 has seen an official, final release now, so I don't expect any breaking changes anymore. I will try to keep it up-to-date.

Installation

First:

git clone https://github.com/DandyDev/pelican-bootstrap3.git

Then:

Point the THEME variable in your pelicanconf.py to /path/to/pelican-bootstrap3

Usage

This theme honors the following standard Pelican settings:

  • Putting feeds in the <head> section:
    • FEED_ALL_ATOM
    • FEED_ALL_RSS
  • Template settings:
    • DISPLAY_PAGES_ON_MENU
    • DISPLAY_CATEGORIES_ON_MENU
    • MENUITEMS
  • Analytics & Comments
    • GOOGLE_ANALYTICS
    • DISQUS_SITENAME

It uses the tag_cloud variable for displaying tags in the sidebar. You can control the amount of tags shown with: TAG_CLOUD_MAX_ITEMS

Categories are disabled by default because I don't use them myself. If you want to show them in the sidebar, uncomment the relevant section in includes/sidebar.html

Extras

reStructuredText styles

If you're using reStructuredText for writing articles and pages, you can include the extra CSS styles that are used by the docutils-generated HTML by setting DOCUTIL_CSS to True. This can be done as a global setting or setting it in the metadata of a specific article or page.

GitHub

The theme can show your most recently active GitHub repos in the sidebar. To enable, provide a GITHUB_USER. Appearance and behaviour can be controlled using the following variables:

  • GITHUB_REPO_COUNT
  • GITHUB_SKIP_FORK
  • GITHUB_SHOW_USER_LINK

Bootswatch and other Bootstrap 3 themes

I included all the lovely Bootstrap 3 themes from Bootswatch, built by Thomas Park. You can tell Pelican what Bootswatch theme to use, by setting BOOTSTRAP_THEME to the desired theme, in lowercase (ie. 'readable' or 'cosmo' etc.). My own site is using Readable. If you want to use any other Bootstrap 3 compatible theme, just put the minified CSS in the static/css directory and rename it using the following naming scheme: bootstrap.{theme-name}.min.css. Then update the BOOTSTRAP_THEME variable with the theme-name used.

AddThis

You can enable sharing buttons through AddThis by setting ADDTHIS_PROFILE to your AddThis profile-id. This will display a Tweet, Facebook Like and Google +1 button under each post.

Facebook Open Graph

In order to make the Facebook like button work better, the template contains Open Graph metatags like <meta property="og:type" content="article"/>. You can disable them by setting USE_OPEN_GRAPH to False. You can use OPEN_GRAPH_FB_APP_ID to provide a Facebook app id. You can also provide a default image that will be passed to Facebook for the homepage of you site by setting OPEN_GRAPH_IMAGE to a relative file path, which will be prefixed by your site's static directory.

Screenshot

Live example

This is my website

About

Bootstrap 3 theme for Pelican

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 75.0%
  • JavaScript 25.0%