pelican-mg/README.md
2015-01-09 00:26:37 +01:00

94 lines
2.6 KiB
Markdown

mg
==============
A minimal theme with a green header bar for [Pelican]
(http://blog.getpelican.com/).
The theme is currently suited for a single author blog without tag pages and
blogroll. Feeds are provided via ATOM.
Warning
--------------
mg is still under development and may do anything it likes up, don't use it on
a production site!
You have been warned!
Live Example
--------------
Check out [my blog](http://www.devsbytes.com).
Features
--------------
* [Open Graph](http://ogp.me) support.
* [Twitter Summary Card](https://dev.twitter.com/cards/types/summary) support.
* [Schema.org](http://schema.org) support.
* Search with [Tipue Search](http://www.tipue.com/search).
* Responsive design.
* Comment with DISQUS.
* Analytics with Google Analytics, PIWIK and StatCounter.
* Share buttons built with share urls.
* Custom footer notice.
Settings
--------------
```python
TAG_SAVE_AS = ''
AUTHOR_SAVE_AS = ''
DIRECT_TEMPLATES = ('index', 'categories', 'archives', 'search', 'tipue_search')
TIPUE_SEARCH_SAVE_AS = 'tipue_search.json'
```
###Optional settings
**ALT_NAME**
An alternative name for your site. It appears in the header bar.
**DESCRIPTION**
A brief description of your site, for Open Graph and search engines.
**FAVICON**
The relative path of your favicon, this is usefull for Disqus forum favicon.
**FAVICON_TYPE**
The MIME type of your favicon, this is usefull for Disqus forum favicon.
**FOOTER**
A custom footer notice.
**META_IMAGE**
The path, as absolute URL, of a custom image for the `og:image` meta
property and Twitter summary card. This image is used in every page of the blog.
Articles and pages can override the default **META_IMAGE** by setting the
"image" metadata in the relative file.
**META_IMAGE_TYPE**
The MIME type for **META_IMAGE**, this is usefull for `og:image:type`.
**PIWIK_URL**
Your PIWIK URL.
**PIKIW_SITE_ID**
The idsite of the website you are tracking with PIWIK.
**SC_PROJECT**
The StatCounter project number.
**SC_SECURITY**
The StatCounter security code for the project.
**SHARE**
Enable share buttons, boolean.
**SOCIAL**
A list of tutples (icon, URL). The icons are from [Font Awesome]
(http://fortawesome.github.io/Font-Awesome/). The suffix "-square" is removed
in the footer icons of the small screen layout.
e.g.
```python
SOCIAL = (('twitter', 'https://twitter.com/luca_chr'),
('google-plus-square', 'https://plus.google.com/117284397605208270870'),
('github', 'https://github.com/lucachr'),
('envelope', 'mailto:luca92web@gmail.com'),)
```