summaryrefslogtreecommitdiff
path: root/themes/after-dark/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'themes/after-dark/README.md')
-rw-r--r--themes/after-dark/README.md87
1 files changed, 87 insertions, 0 deletions
diff --git a/themes/after-dark/README.md b/themes/after-dark/README.md
new file mode 100644
index 0000000..0c43d93
--- /dev/null
+++ b/themes/after-dark/README.md
@@ -0,0 +1,87 @@
+# after-dark
+
+![after-dark screenshot](https://github.com/getzola/after-dark/blob/master/screenshot.png?raw=true)
+
+## Contents
+
+- [Installation](#installation)
+- [Options](#options)
+ - [Top menu](#top-menu)
+ - [Title](#title)
+ - [Author](#author)
+
+## Installation
+First download this theme to your `themes` directory:
+
+```bash
+cd themes
+git clone https://github.com/getzola/after-dark.git
+```
+and then enable it in your `config.toml`:
+
+```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", feed = true},
+ {name = "tags", feed = 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
+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.
+
+### Author
+You can set this on a per page basis or in the config file.
+
+`config.toml`:
+```toml
+[extra]
+author = "John Smith"
+```
+In a page (wrap this in +++):
+```toml
+title = "..."
+date = 1970-01-01
+
+[extra]
+author = "John Smith"
+```
+
+## Original
+This template is based on the Hugo template https://git.habd.as/comfusion/after-dark