@@ -19,7 +19,9 @@ description = "A classic blog theme" | |||||
license = "MIT" | license = "MIT" | ||||
homepage = "https://github.com/Keats/gutenberg-hyde" | homepage = "https://github.com/Keats/gutenberg-hyde" | ||||
# The minimum version of Gutenberg required | # The minimum version of Gutenberg required | ||||
min_version = "0.3" | |||||
min_version = "0.4.0" | |||||
# An optional live demo URL | |||||
demo = "" | |||||
# Any variable there can be overriden in the end user `config.toml` | # Any variable there can be overriden in the end user `config.toml` | ||||
# You don't need to prefix variables by the theme name but as this will | # You don't need to prefix variables by the theme name but as this will | ||||
@@ -3,3 +3,4 @@ | |||||
template = "themes.html" | template = "themes.html" | ||||
sort_by = "date" | sort_by = "date" | ||||
+++ | +++ | ||||
@@ -10,8 +10,9 @@ created = 2018-02-22T19:13:36+01:00 | |||||
updated = 2017-11-07T17:39:37+01:00 | updated = 2017-11-07T17:39:37+01:00 | ||||
repository = "https://github.com/Keats/after-dark" | repository = "https://github.com/Keats/after-dark" | ||||
homepage = "https://github.com/Keats/after-dark" | homepage = "https://github.com/Keats/after-dark" | ||||
minimum_version = "0.2" | |||||
minimum_version = "0.4.0" | |||||
license = "MIT" | license = "MIT" | ||||
demo = "https://gutenberg-after-dark.netlify.com" | |||||
[extra.author] | [extra.author] | ||||
name = "Vincent Prouillet" | name = "Vincent Prouillet" | ||||
@@ -42,6 +43,27 @@ and then enable it in your `config.toml`: | |||||
theme = "after-dark" | theme = "after-dark" | ||||
``` | ``` | ||||
This theme requires your index section (`content/_index.md`) to be paginated to work: | |||||
```toml | |||||
paginate_by = 5 | |||||
``` | |||||
The posts should therefore be in directly under the `content` folder. | |||||
The theme requires tags and categories taxonomies to be enabled in your `config.toml`: | |||||
```toml | |||||
taxonomies = [ | |||||
# You can enable/disable RSS | |||||
{name = "categories", rss = true}, | |||||
{name = "tags", rss = true}, | |||||
] | |||||
``` | |||||
If you want to paginate taxonomies pages, you will need to overwrite the templates | |||||
as it only works for non-paginated taxonomies by default. | |||||
## Options | ## Options | ||||
### Top-menu | ### Top-menu | ||||
@@ -67,4 +89,4 @@ instead. | |||||
## Original | ## Original | ||||
This template is based on the Hugo template https://github.com/comfusion/after-dark | This template is based on the Hugo template https://github.com/comfusion/after-dark | ||||
@@ -10,8 +10,9 @@ created = 2018-02-22T19:13:36+01:00 | |||||
updated = 2018-01-28T10:53:19+01:00 | updated = 2018-01-28T10:53:19+01:00 | ||||
repository = "https://github.com/Keats/book" | repository = "https://github.com/Keats/book" | ||||
homepage = "https://github.com/Keats/book" | homepage = "https://github.com/Keats/book" | ||||
minimum_version = "0.2" | |||||
minimum_version = "0.4.0" | |||||
license = "MIT" | license = "MIT" | ||||
demo = "https://gutenberg-book.netlify.com" | |||||
[extra.author] | [extra.author] | ||||
name = "Vincent Prouillet" | name = "Vincent Prouillet" | ||||
@@ -43,8 +44,26 @@ and then enable it in your `config.toml`: | |||||
```toml | ```toml | ||||
theme = "book" | theme = "book" | ||||
# Optional, if you want search | |||||
build_search_index = true | |||||
``` | ``` | ||||
## Usage | |||||
Book will generate a book from the files you place in the `content` directory. Your book | |||||
can have two levels of hierarchy: chapters and subchapters. | |||||
Each chapter should be a `section` within the Gutenberg site and should have an `_index.md` | |||||
file that sets its `weight` front-matter variable to its chapter number. For example, | |||||
chapter 2 should have `weight = 2`. Additionally, each chapter should also set the | |||||
`sort_by = "weight"` in its front matter. | |||||
Each subchapter should be a `page` and should have its `weight` variable set to the subchapter | |||||
number. For example, subchapter 3.4 should have `weight = 4`. | |||||
Finally, you should create an `_index.md` file and set the `redirect_to` front-matter variable | |||||
to redirect to the first section of your content. For example, if your first section has the | |||||
slug `introduction`, then you would set `redirect_to = "introduction"`. | |||||
## Options | ## Options | ||||
### Numbered chapters | ### Numbered chapters | ||||
@@ -10,8 +10,9 @@ created = 2018-02-22T19:13:36+01:00 | |||||
updated = 2018-01-25T18:44:44+01:00 | updated = 2018-01-25T18:44:44+01:00 | ||||
repository = "https://github.com/Keats/even" | repository = "https://github.com/Keats/even" | ||||
homepage = "https://github.com/Keats/even" | homepage = "https://github.com/Keats/even" | ||||
minimum_version = "0.3" | |||||
minimum_version = "0.4.0" | |||||
license = "MIT" | license = "MIT" | ||||
demo = "https://gutenberg-even.netlify.com" | |||||
[extra.author] | [extra.author] | ||||
name = "Vincent Prouillet" | name = "Vincent Prouillet" | ||||
@@ -43,6 +44,18 @@ and then enable it in your `config.toml`: | |||||
theme = "even" | theme = "even" | ||||
``` | ``` | ||||
The theme requires tags and categories taxonomies to be enabled in your `config.toml`: | |||||
```toml | |||||
taxonomies = [ | |||||
# You can enable/disable RSS | |||||
{name = "categories", rss = true}, | |||||
{name = "tags", rss = true}, | |||||
] | |||||
``` | |||||
If you want to paginate taxonomies pages, you will need to overwrite the templates | |||||
as it only works for non-paginated taxonomies by default. | |||||
## Options | ## Options | ||||
### Top-menu | ### Top-menu | ||||
@@ -10,8 +10,9 @@ created = 2018-01-21T04:35:36-05:00 | |||||
updated = 2018-01-21T04:35:36-05:00 | updated = 2018-01-21T04:35:36-05:00 | ||||
repository = "https://github.com/piedoom/feather" | repository = "https://github.com/piedoom/feather" | ||||
homepage = "https://github.com/piedoom/feather" | homepage = "https://github.com/piedoom/feather" | ||||
minimum_version = "0.2" | |||||
minimum_version = "0.3.4" | |||||
license = "MIT" | license = "MIT" | ||||
demo = "" | |||||
[extra.author] | [extra.author] | ||||
name = "doomy" | name = "doomy" | ||||
@@ -12,6 +12,7 @@ repository = "https://github.com/Keats/hyde" | |||||
homepage = "https://github.com/Keats/gutenberg-hyde" | homepage = "https://github.com/Keats/gutenberg-hyde" | ||||
minimum_version = "0.2" | minimum_version = "0.2" | ||||
license = "MIT" | license = "MIT" | ||||
demo = "" | |||||
[extra.author] | [extra.author] | ||||
name = "Vincent Prouillet" | name = "Vincent Prouillet" | ||||
@@ -84,6 +85,6 @@ To create your own theme, look to the Themes section of [included CSS file](http | |||||
![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png) | ![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png) | ||||
Hyde's page orientation can be reversed by setting `hyde_reversed` to `true` in the `config.toml`. | |||||
Hyde's page orientation can be reversed by setting `hyde_reverse` to `true` in the `config.toml`. | |||||
@@ -10,8 +10,8 @@ | |||||
<p><b>Author:</b> {{page.extra.author.name}}</p> | <p><b>Author:</b> {{page.extra.author.name}}</p> | ||||
<p><b>License:</b> {{page.extra.license}}</p> | <p><b>License:</b> {{page.extra.license}}</p> | ||||
<p><b>Homepage:</b> <a href="{{page.extra.homepage}}">{{page.extra.homepage}}</a></p> | <p><b>Homepage:</b> <a href="{{page.extra.homepage}}">{{page.extra.homepage}}</a></p> | ||||
{% if page.extra.live_demo%} | |||||
<p><b>Live Demo:</b> <a href="{{page.extra.live_demo}}">{{page.extra.live_demo}}</a></p> | |||||
{% if page.extra.demo %} | |||||
<p><b>Live Demo:</b> <a href="{{page.extra.demo}}">{{page.extra.demo}}</a></p> | |||||
{% endif %} | {% endif %} | ||||
<p><b>Last updated:</b> {{page.extra.updated }}</p> | <p><b>Last updated:</b> {{page.extra.updated }}</p> | ||||
</div> | </div> | ||||