Merge pull request #705 from aleylara/master

Peli-Kiera: Fix alignment issues & missing updated README.md

1 files changed, 50 insertions, 26 deletions

diff --git a/Peli-Kiera/README.md b/Peli-Kiera/README.md
index 1a9b6b2..13415b1 100644
--- a/Peli-Kiera/README.md
+++ b/Peli-Kiera/README.md
@@ -24,14 +24,29 @@ In order to get read times and links between articles, the theme requires [pelic
 
 ```bash
 cd project-dir/
+# Please note the plugins repo is quite large and you only need the two.
 git clone https://github.com/getpelican/pelican-plugins
 
 # Add path to your plugins directory in pelicanconf.py
 PLUGIN_PATHS = ['pelican-plugins']
 PLUGINS = ['readtime', 'neighbors']
+```
+A sample article header.
+```text
+Title: Simple is better than complex 
+Date: 2018-11-14
+Tags: python, jupyter, library
+Description: The Zen of Python
+Category: Python
+
+### Introduction
 
-# Go ahead create few articles and populate output
-pelican ./content
+This is a standard paragraph. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
+``` 
+Go ahead and create few articles in respective directories.
+```bash
+# Generate articles and populate output
+pelican content -o output -s pelicanconf.py
 # start the local server on http://localhost:8000/
 pelican --autoreload --listen
 ```
@@ -40,31 +55,39 @@ Final project directory structure should look similiar to this.
 
 ```bash
 (Pelican) ➜ project-dir tree
-│
-├── content
-│   ├── images
-│   │   ├── camera-2008479_640.png
-│   │   ├── camera-wide.png
-│   │   └── wide-wide.png
-│   ├── pages
-│   │   └── about.md
-│   └── Posts
-│       ├── article-one.md
-│       └── article-two.md
+│                                  
 ├── Makefile
-├── output     
+├── content/
+│   ├── Python/
+│   │   ├── article-one.md
+│   │   ├── article-two.md
+│   │   └── article-three.md   
+│   ├── Research/
+│   │   ├── article-one.md
+│   │   ├── article-two.md
+│   │   └── article-three.md
+│   ├── images/
+│   │   ├── camera-2008479_640.png
+│   │   ├── camera-wide.png
+│   │   └── wide-wide.png
+│   └── pages/
+│       └── about.md
+├── output/ 
+│ 
 ├── pelicanconf.py
-├── pelican-plugins
+├── pelican-plugins/
 │   ├── neighbors
-│   │   
+│   │   ├── Readme.rst
+│   │   ├── __init__.py
+│   │   └── neighbors.py
 │   └── readtime
-│       
+│       ├── README.md
+│       ├── __init__.py
+│       └── readtime.py     
 ├── publishconf.py
-├── __pycache__
-│   
 ├── tasks.py
 └── themes
-    └── Peli-Kiera
+    └── Peli-Kiera/
 ```
 
 ### Settings
@@ -78,17 +101,18 @@ from __future__ import unicode_literals
 AUTHOR = 'Author'
 COPYRIGHT = '2019'
 SITENAME = 'Site-Name'
-SITEURL = ''
-SITESUBTITLE = Site Subtitle'
+SITEURL = 'https://www.example.com'
+SITESUBTITLE = 'Site Subtitle'
 PATH = 'content'
 TIMEZONE = 'America/New_York'
 DEFAULT_LANG = 'en'
 
 THEME = 'themes/Peli-Kiera'
-PLUGIN_PATHS = ['plugins']
+PLUGIN_PATHS = ['pelican-plugins']
 PLUGINS = ['readtime', 'neighbors']
 STATIC_PATHS = ['images']
-SUMMARY_MAX_LENGTH = 60
+# Article summary length on main index page
+SUMMARY_MAX_LENGTH = 100
 DEFAULT_PAGINATION = 10
 GITHUB_URL = 'https://github.com/'
 
@@ -134,14 +158,14 @@ The pagination is presented with the current page and 3 neighboring pages on eit
 Images can be moved on page by adding the tag `#float-right`, `#float-left`, `#mid` and `#full` in your markdown.
 
 ```markdown
-![Title]({static}/images/my_image-600x400.png#float-right "")
+![Title]({static}/images/my_image-600x400.png#float-right "camera icon")
 ``` 
   
 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="">
+    <img src="path-to/images/my_image-600x400.png" alt="camera icon">
 </figure>
 ``` 
 Minimum image width of 600px is recommended. Images scale accordingly on smaller screens.