README.md in mere-blog-theme-0.1.1 vs README.md in mere-blog-theme-0.2
- old
+ new
@@ -1,7 +1,10 @@
# mere-blog-theme
+[![Gem Version](https://badge.fury.io/rb/mere-blog-theme.svg)](https://badge.fury.io/rb/mere-blog-theme)
+![Gem](https://img.shields.io/gem/dt/mere-blog-theme)
+
Mere is a minimal and simple blog theme, and nothing more, for use with Jekyll and GitHub Pages. It has been built with the Bulma frontend framework.
It has a homepage which displays the latest 6 posts and a paginated blog page used to list out all blog posts.
@@ -30,10 +33,11 @@
## Usage
* [Blog Setup](#blog-setup)
* [Posts](#posts)
* [Homepage](#homepage)
+* [Authors](#authors)
* [Google Analytics](#google-analytics)
### Blog Setup
Create a `blog` directory with an `index.html` file inside it. Set the front matter of the `blog/index.html` page with the layout of blog.
@@ -72,9 +76,47 @@
title: Mere Blog Theme
subtitle: This is the demo site for the Mere Blog Theme
image: /img/home.jpg
hero_height: is-large
```
+
+### Authors
+
+To enable the authors section, create a directory named `_authors` and create a page for each author within it. The author pages should have front matter in the following format.
+
+**NOTE** The author name should match the author name in their posts exactly.
+
+```yaml
+layout: author
+title: The authors page title
+name: Author Name
+position: Web Designer
+description: The short description of the author
+avatar: /img/avatar.png
+website: https://www.csrhymes.com
+```
+
+The website and avatar are optional, but if you are stuck for author images, why not try [https://getavataaars.com](https://getavataaars.com). Square images work best. You can then write about the author in the page content.
+
+Next, create an `authors.md` page in the root of your site and set the layout to authors.
+
+```yaml
+layout: authors
+title: Authors
+description: The authors page
+```
+
+Add authors as a collection in your _config.yml file with output set to true so the pages are generated.
+
+```yaml
+collections:
+ authors:
+ output: true
+```
+
+When you build your site, the authors link will appear in the navbar. The authors page will display the authors you have added. You can then click on their name or image to view the author page, along with a list of their 4 latest posts.
+
+There will also be a link back to the authors page at the bottom of the post.
### Google Analytics
To enable Google Analytics add `google_analytics: UA-xxxxxxxx` to your `_config.yml` replacing the UA-xxxxxxxx with your Google Analytics property.