Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 3.92 KB

README.md

File metadata and controls

93 lines (62 loc) · 3.92 KB
Raw

Fresh: a responsive Pelican theme that uses HTML5

Fresh is a responsive Pelican theme. This theme uses HTML5 and its layout is responsive -- thanks to Smashing HTML5 and Twitter Bootstrap.

You can watch a live demo for the Fresh theme here.

Note

Make sure not to set the RELATIVE_URLS global varibles to True (the default value is False) so that Facebook meta tags and canonical links are generated correctly.

Features

  • Google Analytics
  • DISQUS comment system
  • Custom link lists
  • Social widgets
  • "Fork me on GitHub" ribbon
  • Google Custom Search Engine -- use this as your search bar!
  • Hide categories from menu
  • Syntax highlighting for code blocks
  • ShareThis

Settings

The Fresh theme supports most built-in global variables of Pelican. There are also theme-specific global variables that allow you to add a search bar or to hide categories from menu.

Built-in Global Variables

The theme supports most Pelican built-in global variables, and some of them are listed below.

  • GOOGLE_ANALYTICS
  • DISQUS_SITENAME
  • LINKS = (('name1', 'url1'), ('name2', 'url2'))
  • SOCIAL = (('name1', 'url1'), ('name2', 'url2'))
  • GITHUB_URL

Refer to Pelican's documentation of settings for description of these global variables.

Theme-specific Global Variables

The theme also provides these global variables:

  • GOOGLE_CUSTOM_SEARCH = 'your search engine unique ID'

    The Fresh theme allows you to use Google Custom Search Engine as the search engine for your static website.

    Find the search engine unique ID of your customized search engine in Google Custom Search Engine's control panel. Assign this ID to the GOOGLE_CUSTOM_SEARCH variable in your configuration, and a Google custom search bar will appear in the navigation bar.

  • HIDE_CATEGORIES_FROM_MENU = True

    If you want to hide categories from menu, you can do so by setting HIDE_CATEGORIES_FROM_MENU to True in your configuration.

  • SHARETHIS_PUB_KEY = 'your ShareThis Pub Key'

    The Fresh theme allows you to use ShareThis for social plugins.

    Find the Pub Key of your ShareThis Account in ShareThis's Account Dashboard. Assign this ID to the SHARETHIS_PUB_KEY variable in your configuration, and two rows of social plugin buttons will appear before and after your article respectively.

License

Copyright (c) 2013-2014, Jui-Shan Liang <[email protected]>

All rights reserved.

Licensed under GPL v2.

Websites that use Fresh

It's glad to know that the Fresh Theme has been used around the world. Below is a list of sites in alphabetical order that uses Fresh discovered on the Internet. If you're using Fresh and would like your site to be listed here, feel free to edit this file and send me a pull request. :)

  1. cacaojvm.org