diff options
Diffstat (limited to 'syte/README.md')
| -rw-r--r-- | syte/README.md | 54 |
1 files changed, 50 insertions, 4 deletions
diff --git a/syte/README.md b/syte/README.md index 0d86f68..c9159ec 100644 --- a/syte/README.md +++ b/syte/README.md @@ -1,13 +1,59 @@ Syte theme for Pelican ====================== -This theme is based on [Syte][syte] and is for Pelican. Right now, its a bit messy. But I'll clean this up later. +This theme is based on [Syte][syte] and is for Pelican. It has been instanciated by [samrat][samrat] and continued by [arnaudbos][arnaudbos]. -Anyway, you can [see this theme in action here][samrat]. +You can [see this theme in action here][sneakernet]. - + -To try this out, clone this repo and in your `settings.py`, set `THEME = /path/to/syte-pelican` and `MEDIA_URL= /path/to/syte-pelican/static`. +Settings +-------- + +This theme uses the SOCIAL setting from Pelican and build social integration on top of it with JavaScript calls. +All these settings are optional, not using them will simply not enable the social integration and the links will remain just links. + +#### HTML (OPTIONAL) + +* ABOUT = u'Describe yourself or your site here, this will go right under the site name' +* SITE_DESCRIPTION = u'Used in HTML meta tag for description' +* SITE_KEYWORDS = u'Used in the HTML meta tag for keywords' + +###### Not so optional + +Pelican-syte uses the webassets module integrated into Pelican, so you will also need to install it ( `pip install webassets` ) and add the `WEBASSETS = True` setting. + +#### Links + +* DISPLAY_HOME_ON_MENU = True (If you still want to display a 'Home' link, note that the site name is already a link to the home page) +* GOOGLE_PLUSONE = True (If you want a Google +1 button aside the Tweet button on each article) +* CONTACT = u'your@email.com' (Pretty explicit) + +#### Social integration + +###### Github integration + +* GITHUB_INTEGRATION_ENABLED = True (If you want to integrate Github) +* GITHUB_USERNAME = 'your_username' (Needed if GITHUB_INTEGRATION_ENABLED is set to True) + +###### Google integration + +* GPLUS_INTEGRATION_ENABLED = True (If you want to integrate Google+) +* GPLUS_USERNAME = 'your_username|identifier' (Needed if GPLUS_INTEGRATION_ENABLED is set to True) +* GPLUS_API_ACCESS = 'your_api_access_key' (Needed if GPLUS_INTEGRATION_ENABLED is set to True) + +###### Twitter+ integration + +* TWITTER_INTEGRATION_ENABLED = True (If you want to integrate Twitter) +* TWITTER_USERNAME = 'your_username' (Needed if TWITTER_INTEGRATION_ENABLED is set to True) + +###### Instagram integration + +* INSTAGRAM_INTEGRATION_ENABLED = True (If you want to integrate Instagram) +* INSTAGRAM_USERNAME = 'your_username' (Needed if INSTAGRAM_INTEGRATION_ENABLED is set to True) +* INSTAGRAM_API_ACCESS = 'your_api_access_key' (Needed if INSTAGRAM_INTEGRATION_ENABLED is set to True) [syte]: http://rigoneri.github.com/syte/ [samrat]: http://samrat.github.com +[arnaudbos]: http://github.com/arnaudbos/ +[sneakernet]: http://www.sneakernet.fr/ |