diff --git a/README.md b/README.md index 1ac4002..bc90f25 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,10 @@ 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 +A minimal theme for [Pelican](http://blog.getpelican.com/) that uses uikit. +The theme is suited for a single author blog without tag pages nor 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). @@ -25,6 +18,7 @@ Features * Search with [Tipue Search](http://www.tipue.com/search). * Responsive design. * Comment with DISQUS. +* SCSS style sheets. * Analytics with Google Analytics, PIWIK and StatCounter. * Share buttons built with share urls. * Custom footer notice. @@ -32,6 +26,8 @@ Features Settings -------------- +The following settings are required for a correct behaviour of this theme. + ```python TAG_SAVE_AS = '' AUTHOR_SAVE_AS = '' @@ -45,31 +41,25 @@ Settings 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. +A brief description of your site, for social networks and search engines. **FAVICON** -The relative path of your favicon, this is usefull for Disqus forum favicon. +The relative path of your favicon, this is needed for Disqus forum favicon. **FAVICON_TYPE** -The MIME type of your favicon, this is usefull for Disqus forum favicon. +The MIME type of your favicon, this is needed 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. +The absolute URL of a custom image for the `og:image` meta property, Twitter +summary card, and `image` meta property of Schema.org. 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. +The MIME type for **META_IMAGE**, this is needed for `og:image:type`. **SC_PROJECT** The StatCounter project number. @@ -91,3 +81,73 @@ e.g. ('github', 'https://github.com/lucachr'), ('envelope', 'mailto:luca92web@gmail.com'),) ``` + +Example Configuration +---------------------- + +This is the settings file for Dev's Bytes. + +```python + #!/usr/bin/env python + # -*- coding: utf-8 -*- # + from __future__ import unicode_literals + + AUTHOR = 'Luca Chiricozzi' + SITENAME = "Dev's Bytes" + ALT_NAME = "#! " + SITENAME + SITESUBTITLE = "Random programming stuff" + DESCRIPTION = "A blog about programming, *nix, and software development." + SITEURL = 'http://www.devsbytes.com' + FAVICON = 'favicon.ico' + FAVICON_TYPE = 'image/vnd.microsoft.icon' + + META_IMAGE = SITEURL + "/static/img/og_logo.jpg" + META_IMAGE_TYPE = "image/jpeg" + + PATH = 'content' + + TIMEZONE = 'Europe/Rome' + + DEFAULT_LANG = 'en' + LOCALE = 'en_GB' + + THEME = "themes/mg" + + # Social widget + SOCIAL = (('twitter', 'https://twitter.com/luca_chr'), + ('google-plus-square', 'https://plus.google.com/+LucaChiricozzi'), + ('github', 'https://github.com/lucachr'), + ('envelope', 'mailto:luca92web@gmail.com'),) + + SHARE = True + + FOOTER = ("© 2015 Luca Chiricozzi. All rights reserved.
" + + "Code snippets in the pages are released under " + + "" + + "The MIT License, unless otherwise specified.") + + + DEFAULT_PAGINATION = 10 + + TAG_SAVE_AS = '' + AUTHOR_SAVE_AS = '' + DIRECT_TEMPLATES = ('index', 'categories', 'archives', 'search', 'tipue_search') + TIPUE_SEARCH_SAVE_AS = 'tipue_search.json' + + RELATIVE_URLS = False + + FEED_ALL_ATOM = 'feeds/all.atom.xml' + + DELETE_OUTPUT_DIRECTORY = True + + TWITTER_USERNAME = 'luca_chr' + DISQUS_SITENAME = "devsbytes" + SC_PROJECT = '10224955' + SC_SECURITY = '1f2cc438' + +``` + +License +--------- + +mg is released under [the MIT License](http://opensource.org/licenses/MIT).