Browse Source

Update themes docs

index-subcmd
Vincent Prouillet 5 years ago
parent
commit
3db404c9f9
8 changed files with 68 additions and 9 deletions
  1. +3
    -1
      docs/content/documentation/themes/creating-a-theme.md
  2. +1
    -0
      docs/content/themes/_index.md
  3. +24
    -2
      docs/content/themes/after-dark/index.md
  4. +20
    -1
      docs/content/themes/book/index.md
  5. +14
    -1
      docs/content/themes/even/index.md
  6. +2
    -1
      docs/content/themes/feather/index.md
  7. +2
    -1
      docs/content/themes/hyde/index.md
  8. +2
    -2
      docs/templates/theme.html

+ 3
- 1
docs/content/documentation/themes/creating-a-theme.md View File

@@ -19,7 +19,9 @@ description = "A classic blog theme"
license = "MIT"
homepage = "https://github.com/Keats/gutenberg-hyde"
# 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`
# You don't need to prefix variables by the theme name but as this will


+ 1
- 0
docs/content/themes/_index.md View File

@@ -3,3 +3,4 @@
template = "themes.html"
sort_by = "date"
+++

+ 24
- 2
docs/content/themes/after-dark/index.md View File

@@ -10,8 +10,9 @@ created = 2018-02-22T19:13:36+01:00
updated = 2017-11-07T17:39:37+01:00
repository = "https://github.com/Keats/after-dark"
homepage = "https://github.com/Keats/after-dark"
minimum_version = "0.2"
minimum_version = "0.4.0"
license = "MIT"
demo = "https://gutenberg-after-dark.netlify.com"

[extra.author]
name = "Vincent Prouillet"
@@ -42,6 +43,27 @@ and then enable it in your `config.toml`:
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

### Top-menu
@@ -67,4 +89,4 @@ instead.
## Original
This template is based on the Hugo template https://github.com/comfusion/after-dark


+ 20
- 1
docs/content/themes/book/index.md View File

@@ -10,8 +10,9 @@ created = 2018-02-22T19:13:36+01:00
updated = 2018-01-28T10:53:19+01:00
repository = "https://github.com/Keats/book"
homepage = "https://github.com/Keats/book"
minimum_version = "0.2"
minimum_version = "0.4.0"
license = "MIT"
demo = "https://gutenberg-book.netlify.com"

[extra.author]
name = "Vincent Prouillet"
@@ -43,8 +44,26 @@ and then enable it in your `config.toml`:

```toml
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

### Numbered chapters


+ 14
- 1
docs/content/themes/even/index.md View File

@@ -10,8 +10,9 @@ created = 2018-02-22T19:13:36+01:00
updated = 2018-01-25T18:44:44+01:00
repository = "https://github.com/Keats/even"
homepage = "https://github.com/Keats/even"
minimum_version = "0.3"
minimum_version = "0.4.0"
license = "MIT"
demo = "https://gutenberg-even.netlify.com"

[extra.author]
name = "Vincent Prouillet"
@@ -43,6 +44,18 @@ and then enable it in your `config.toml`:
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

### Top-menu


+ 2
- 1
docs/content/themes/feather/index.md View File

@@ -10,8 +10,9 @@ created = 2018-01-21T04:35:36-05:00
updated = 2018-01-21T04:35:36-05:00
repository = "https://github.com/piedoom/feather"
homepage = "https://github.com/piedoom/feather"
minimum_version = "0.2"
minimum_version = "0.3.4"
license = "MIT"
demo = ""

[extra.author]
name = "doomy"


+ 2
- 1
docs/content/themes/hyde/index.md View File

@@ -12,6 +12,7 @@ repository = "https://github.com/Keats/hyde"
homepage = "https://github.com/Keats/gutenberg-hyde"
minimum_version = "0.2"
license = "MIT"
demo = ""

[extra.author]
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'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`.


+ 2
- 2
docs/templates/theme.html View File

@@ -10,8 +10,8 @@
<p><b>Author:</b> {{page.extra.author.name}}</p>
<p><b>License:</b> {{page.extra.license}}</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 %}
<p><b>Last updated:</b> {{page.extra.updated }}</p>
</div>


Loading…
Cancel
Save