116 lines
2.7 KiB
Markdown
116 lines
2.7 KiB
Markdown
# after-dark
|
|
|
|
|
|
|
|
## 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"
|
|
```
|
|
|
|
### KaTeX math formula support
|
|
|
|
This theme contains math formula support using [KaTeX](https://katex.org/),
|
|
which can be enabled by setting `katex_enable = true` in the `extra` section
|
|
of `config.toml`:
|
|
|
|
```toml
|
|
[extra]
|
|
katex_enable = true
|
|
```
|
|
|
|
After enabling this extension, the `katex` short code can be used in documents:
|
|
* `{{ katex(body="\KaTeX") }}` to typeset a math formula inlined into a text,
|
|
similar to `$...$` in LaTeX
|
|
* `{% katex(block=true) %}\KaTeX{% end %}` to typeset a block of math formulas,
|
|
similar to `$$...$$` in LaTeX
|
|
|
|
#### Automatic rendering without short codes
|
|
|
|
Optionally, `\\( \KaTeX \\)` inline and `\\[ \KaTeX \\]` / `$$ \KaTeX $$`
|
|
block-style automatic rendering is also supported, if enabled in the config:
|
|
|
|
```toml
|
|
[extra]
|
|
katex_enable = true
|
|
katex_auto_render = true
|
|
```
|
|
|
|
## Original
|
|
This template is based on the Hugo template https://git.habd.as/comfusion/after-dark
|