commit	fc48ff8273d1137814de36d8aec36be56be3d152	[log] [tgz]
author	pR0Ps <pR0Ps.CM@gmail.com>	Thu Jan 15 01:32:41 2015 -0500
committer	pR0Ps <pR0Ps.CM@gmail.com>	Thu Jan 15 01:35:35 2015 -0500
tree	eefdd6cbdc0c330a227dda9c7411b16c95912894
parent	2afe426209ec4c65a711d0313b20f82e97130d9a [diff]

tree: eefdd6cbdc0c330a227dda9c7411b16c95912894

README.md

Subtle Pelican Theme

pelican-subtle is a responsive theme for Pelican, it is my take on Giulio Fidente's pelican-svbhack theme.

Demo

You can see the theme in action on my site.

theme screenshot

Features

Clean, responsive design
Profile image and tagline
Syntax highlighting for pre blocks
Google Analytics (new Unified Analytics)
Google Authorship
Supports displaying a custom list of links with icons in the sidebar
Global keyword support
Fuzzy date display using Javascript

Installing

Clone the repository making sure to get the submodules (ex: git clone --recursive [repo])
Edit pelicanconf.py and modify the THEME variable to point to the downloaded theme location.

pelicanconf.py

When developing locally, you may want to set SITEURL to somrething like http://localhost:8000

This theme supports a number of custom variables:

GOOGLE_ANALYTICS_ID: Your Google Analytics UA-XXXXXXXX-X code (None to disable analytics).
GOOGLE_ANALYTICS_PROP: Your Google Analytics property name (None to disable analytics).
GOOGLE_PLUS_URL: A link to your Google+ profile. Used for the Google Authorship feature.
USER_LOGO_URL: The image to display as the profile image. Can be local or a remote URL.
DISQUS_SITENAME: Set this to enable Disqus comments on articles.
TAGLINE: The site's tagline. Rendered right below the image.
SCROLL_TO_CONTENT: If this is set to True, when content is below the sidebar (for example, on mobile), the page will be scrolled down to the content when it loads. An exception is made for the home page.
MANGLE_EMAILS: If enabled, any emails in the SOCIAL links will be obfuscated in HTML and have their links generated by Javascript when the page loads.
GLOBAL_KEYWORDS: A list of strings that will be set as keywords for each page.
FUZZY_DATES: If True, uses lw-timeago to display fuzzy dates on articles (eg. 'Posted 3 months ago').
SERVER_LESS: If True, static/css/style.css will be used as the style (compile it server-side). Otherwise static/css/style.less will be compiled client-side with less.js.

Authors

pelican-subtle is authored by pR0Ps.

pelican-svbhack is authored by Giulio Fidente.

Pull requests welcome!

Licence

The MIT License (MIT)
Copyright (c) 2012 William Ting
Copyright (c) 2013 Giulio Fidente
Copyright (c) 2015 Carey Metcalfe

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.