diff options
Diffstat (limited to 'Peli-Kiera/README.md')
| -rw-r--r-- | Peli-Kiera/README.md | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/Peli-Kiera/README.md b/Peli-Kiera/README.md new file mode 100644 index 0000000..0628475 --- /dev/null +++ b/Peli-Kiera/README.md @@ -0,0 +1,111 @@ + +# Peli-Kiera +Peli-Kiera is a theme for the Pelican static site generator. +Thanks to the [Hugo-Kiera](https://github.com/avianto/hugo-kiera) project for the inspiration. +### Demo +Live-Demo at [https://aleylara.github.io/Peli-Kiera](https://aleylara.github.io/Peli-Kiera) +### Installation +The theme can be installed by cloning the repo into your +themes path and pointing to it in your `pelicanconf.py`. +```bash +# Create a themes directory if it doesn't exists +cd project-dir/themes +git clone https://github.com/aleylara/Peli-Kiera + +# Path to your theme directory in pelicanconf.py +THEME = 'themes/Peli-Kiera' +``` +In order to get read times and links between articles, the theme requires [pelican-readtime](https://github.com/getpelican/pelican-plugins/tree/master/readtime) and [neighbors](https://github.com/getpelican/pelican-plugins/tree/master/neighbors) plugins. + +```bash +# Path to your plugins directory in pelicanconf.py +PLUGIN_PATHS = ['pelican-plugins'] +PLUGINS = ['readtime', 'neighbors'] +``` +### Settings + +```python +#!/usr/bin/env python +# -*- coding: utf-8 -*- # +from __future__ import unicode_literals + +AUTHOR = 'Author' +SITENAME = 'Site-Name' +SITEURL = '' +SITESUBTITLE = Site Subtitle' +PATH = 'content' +TIMEZONE = '###########/#######' +DEFAULT_LANG = 'en' + +THEME = 'themes/Peli-Kiera' +PLUGIN_PATHS = ['plugins'] +PLUGINS = ['readtime', 'neighbors'] +STATIC_PATHS = ['images'] +SUMMARY_MAX_LENGTH = 60 +DEFAULT_PAGINATION = 10 +GITHUB_URL = 'https://github.com/' + +# Feed generation is usually not desired when developing +FEED_ALL_ATOM = 'feeds/all.atom.xml' +CATEGORY_FEED_ATOM = None +TRANSLATION_FEED_ATOM = None +AUTHOR_FEED_ATOM = None +AUTHOR_FEED_RSS = None +RSS_FEED_SUMMARY_ONLY = True + +# Social widget +SOCIAL = ( + ('twitter', 'https://twitter.com/'), + ('linkedin', 'https://www.linkedin.com'), + ('github', 'https://github.com/'), + ('gitlab', 'https://gitlab.com/'), + ('facebook', 'https://facebook.com'), + ('instagram', 'https://instagram.com'), +) + +# DISQUS_SITENAME = '' +# GOOGLE_ANALYTICS = '' + +# Uncomment following line if you want document-relative URLs when developing +# RELATIVE_URLS = True +``` + +### Features +* Atom/RSS feeds +* Mobile friendly +* Google analytics +* Comments via Disqus +* Font awesome icons +* Modified pagination +* Image placements + +### Pagination and image placement +The pagination is presented with the current page and 3 neighboring pages on either side. + + << < 7 8 9 **10** 11 12 13 > >> + +Images can be moved on page by adding the tag `#float-right`, `#float-left`, `#mid` and `#full` in your markdown. + +```markdown + +``` + +Similarly, the placement can also be applied to html directly by wrapping images in a `<figure class="placement">` tag. + +```html +<figure class="float-left"> + <img src="path-to/images/my_image-600x400.png" alt=""> +</figure> +``` +Minimum image width of 600px is recommended. Images scale accordingly on smaller screens. + +### Preview + + + + +You can leave feedback or say thanks [here 👍](https://saythanks.io/to/aleylara) + +### License +[MIT License](https://github.com/avianto/hugo-kiera/blob/master/LICENSE.md) + |