after-dark/README.md

70 lines
1.7 KiB
Markdown
Raw Normal View History

2017-11-03 09:31:31 +00:00
# after-dark
2018-11-14 18:58:02 +00:00
![after-dark screenshot](https://github.com/getzola/after-dark/blob/master/screenshot.png?raw=true)
2017-11-03 09:31:31 +00:00
## Contents
- [Installation](#installation)
- [Options](#options)
- [Top menu](#top-menu)
- [Title](#title)
## Installation
First download this theme to your `themes` directory:
```bash
$ cd themes
2018-11-14 18:58:02 +00:00
$ git clone https://github.com/getzola/after-dark.git
2017-11-03 09:31:31 +00:00
```
and then enable it in your `config.toml`:
```toml
theme = "after-dark"
```
2018-03-18 08:37:26 +00:00
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.
2018-07-31 14:33:12 +00:00
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.
2017-11-03 09:31:31 +00:00
## Options
### Top-menu
Set a field in `extra` with a key of `after_dark_menu`:
```toml
after_dark_menu = [
{url = "$BASE_URL", name = "Home"},
{url = "$BASE_URL/categories", name = "Categories"},
{url = "$BASE_URL/tags", name = "Tags"},
{url = "https://google.com", name = "Google"},
]
```
If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
site URL.
### Title
The site title is shown on the homepage. As it might be different from the `<title>`
element that the `title` field in the config represents, you can set the `after_dark_title`
instead.
2017-11-07 16:37:54 +00:00
## Original
This template is based on the Hugo template https://git.habd.as/comfusion/after-dark