Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 2.17 KB

README.md

File metadata and controls

80 lines (53 loc) · 2.17 KB
Raw

SVBTLE

Svbtle theme is a close copy of Svbtle.com with a few minor changes for use with Pelican.

DEMO

You can see the theme in action, or the site code here.

theme screenshot

FEATURES

  • syntax highlighting for code blocks
  • Google Analytics
  • Disqus commenting
  • custom list of links
  • support for this LaTeX plugin

KNOWN ISSUES

  • no IE testing
  • no custom menu
  • header date format is hardcoded in ./templates/header.html with the exception of articles.
  • Svbtle uses Freight-Sans-Pro for article titles and Proxima Nova for body. While they are great fonts, neither are free. I've linked to them in case the client has them installed, but most users will browse the site with Open Sans.

INSTALL

FROM SOURCE

Download the repository and save it somewhere accessible. Edit settings.py and modify the THEME variable to point to the downloaded theme location.

FROM OFFICIAL REPO

Please refer to Pelican theme install instructions.

SETTINGS.PY

These are the Pelican global variables currently supported by the theme:

  • GOOGLE_ANALYTICS
  • GAUGES_ANALYTICS
  • DISQUS_SITENAME
  • LINKS(('name1', 'url1'), ('name2', 'url2'))
  • DEFAULT_DATE_FORMAT = ('%b %d, %Y'): suggested date format
  • FEED_DOMAIN = SITEURL
  • AUTHOR_BIO, providing a short bio that appears on the side bar.

When developing locally, set the following variable:

SITEURL = http://localhost:8000

If you want to enable LaTeX support, additional settings must be configured.

MODIFICATION

  • Accent color can be changed by editing @accent in ./static/css/style.less.

  • A different Pygmentize theme can be used by editing ./Makefile and running make pygments.

AUTHOR

William Ting

LICENSE

Released under MIT License, full details in LICENSE file.