diff --git a/README.md b/README.md index ee629da..1b8c41d 100644 --- a/README.md +++ b/README.md @@ -15,23 +15,41 @@ It is ported from ghost theme [attila](https://github.com/zutrinken/attila) Demo blog [source code](https://github.com/arulrajnet/attila-demo) +## Install + +The recommend way to install is using pelican-themes command. + +* Download latest zip from [release](https://github.com/arulrajnet/attila/releases) +* Unzip that file +* Then `sudo pelican-themes -U attila` . Here attila is the extracted folder name +* Now list all themes `sudo pelican-themes -l` +* Use that theme name in your pelicanconf.py + ## Features * Responsive layout * Navigation support * Paralax cover images for posts, author archives and blog * Author informations for posts and author archives -* Featured posts +* Featured posts (via [plugin](https://github.com/getpelican/pelican-plugins/tree/master/neighbors)) * Reading progress for posts * Automatic code syntax highlight * Disqus support +* Google Analytics, GAUGES and PIWIKI * Sharing buttons +* Open Graph +* Rich Snippets (JSON-LD) +* [Multiple Code Highlight Styles](#code-highlights) -## Setup +## Docs + +[Wiki](https://github.com/arulrajnet/attila/wiki) + +## Setup a blog Refer [more setting](https://github.com/arulrajnet/attila-demo/blob/master/pelicanconf.py) -All configurations about this theme. +Here are all configurations about this theme. #### Header Covers @@ -138,7 +156,7 @@ Accept many analytics: - To customize header cover to articles, insert the metadata ``header_cover``. - To customize OpenGraph images, insert the metadata ``og_image``, otherwise - ``header_cover``, ``HEADER_COVER`` or a default image is used. + ``cover``, ``HEADER_COVER`` or a default image is used. - To customize Twitter card images, insert the metadata ``twitter_image``, otherwise ``header_cover``, ``HEADER_COVER`` or a default image is used. Twitter cards are automatically generated if the ``twitter`` icon is configured @@ -154,6 +172,20 @@ refer this [https://github.com/arulrajnet/attila-demo](https://github.com/arulra **Author Screen** ![screenshot](screenshot.png) +## Contributing + +Always open an issue before sending a PR. Talk about the problem/feature that you want to fix. If it's really a good thing you can submit your PR. If you send an PR without talking about before what it is, you may work for nothing. + +As always, if you want something that only make sense to you, just fork attila and start a new theme. + +## Donate + +Did you liked this theme? Pay my bills and support new features. + +[![Gratipay](https://img.shields.io/gratipay/user/arulrajnet.svg?maxAge=2592000)](https://gratipay.com/~arulrajnet/) + +[![PayPal](https://img.shields.io/badge/paypal-donate-yellow.svg?maxAge=2592000)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=XYLX6LG2THL2J) + ## Copyright & License Copyright (c) 2015-2016 Peter Amende - Released under The MIT License.