pelican-mg/README.md

94 lines
2.6 KiB
Markdown
Raw Normal View History

2014-12-29 22:08:56 +00:00
mg
==============
2015-01-01 21:22:36 +00:00
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.
2014-12-29 22:08:56 +00:00
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!
2014-12-30 00:48:06 +00:00
Live Example
--------------
Check out [my blog](http://www.devsbytes.com).
2014-12-29 22:08:56 +00:00
Features
--------------
2015-01-01 21:22:36 +00:00
* [Open Graph](http://ogp.me) support.
* [Twitter Summary Card](https://dev.twitter.com/cards/types/summary) support.
* [Schema.org](http://schema.org) support.
2015-01-08 23:18:22 +00:00
* Search with [Tipue Search](http://www.tipue.com/search).
2015-01-01 21:22:36 +00:00
* Responsive design.
2014-12-29 22:08:56 +00:00
* Comment with DISQUS.
2015-01-08 23:18:22 +00:00
* Analytics with Google Analytics, PIWIK and StatCounter.
2014-12-29 22:08:56 +00:00
* Share buttons built with share urls.
* Custom footer notice.
Settings
--------------
2015-01-01 21:22:36 +00:00
```python
TAG_SAVE_AS = ''
AUTHOR_SAVE_AS = ''
2015-01-08 23:18:22 +00:00
DIRECT_TEMPLATES = ('index', 'categories', 'archives', 'search', 'tipue_search')
TIPUE_SEARCH_SAVE_AS = 'tipue_search.json'
2015-01-01 21:22:36 +00:00
```
###Optional settings
2014-12-30 20:17:01 +00:00
2014-12-30 21:16:07 +00:00
**ALT_NAME**
2014-12-30 20:17:01 +00:00
An alternative name for your site. It appears in the header bar.
2014-12-29 22:13:29 +00:00
**DESCRIPTION**
2014-12-29 22:08:56 +00:00
A brief description of your site, for Open Graph and search engines.
2015-01-01 21:22:36 +00:00
**FAVICON**
The relative path of your favicon, this is usefull for Disqus forum favicon.
2015-01-01 21:25:20 +00:00
**FAVICON_TYPE**
The MIME type of your favicon, this is usefull for Disqus forum favicon.
2014-12-29 22:13:29 +00:00
**FOOTER**
2014-12-29 22:08:56 +00:00
A custom footer notice.
2015-01-01 21:22:36 +00:00
**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.
2014-12-29 22:08:56 +00:00
2015-01-01 21:22:36 +00:00
**META_IMAGE_TYPE**
The MIME type for **META_IMAGE**, this is usefull for `og:image:type`.
2014-12-29 22:08:56 +00:00
2015-01-08 23:18:22 +00:00
**PIWIK_URL**
Your PIWIK URL.
**PIKIW_SITE_ID**
2015-01-08 23:20:19 +00:00
The idsite of the website you are tracking with PIWIK.
2015-01-08 23:18:22 +00:00
**SC_PROJECT**
The StatCounter project number.
**SC_SECURITY**
The StatCounter security code for the project.
2015-01-08 23:26:37 +00:00
**SHARE**
Enable share buttons, boolean.
2015-01-08 23:26:04 +00:00
**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.
2014-12-29 22:08:56 +00:00
```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'),)
```