1 2+++ 3title = "even" 4description = "A robust, elegant dark theme" 5template = "theme.html" 6date = 2021-12-02T23:22:24+01:00 7 8[extra] 9created = 2021-12-02T23:22:24+01:00 10updated = 2021-12-02T23:22:24+01:00 11repository = "https://github.com/getzola/even.git" 12homepage = "https://github.com/getzola/even" 13minimum_version = "0.11.0" 14license = "MIT" 15demo = "https://zola-even.netlify.com" 16 17[extra.author] 18name = "Vincent Prouillet" 19homepage = "https://www.vincentprouillet.com" 20+++ 21 22# Even 23Even is a clean, responsive theme based on the Hugo theme with the same name featuring categories, tags and pagination. 24 25![even screenshot](https://github.com/getzola/even/blob/master/screenshot.png?raw=true) 26 27## Contents 28 29- [Installation](#installation) 30- [Options](#options) 31 - [Top menu](#top-menu) 32 - [Title](#title) 33 34## Installation 35First download this theme to your `themes` directory: 36 37```bash 38cd themes 39git clone https://github.com/getzola/even.git 40``` 41and then enable it in your `config.toml`: 42 43```toml 44theme = "even" 45``` 46 47The theme requires tags and categories taxonomies to be enabled in your `config.toml`: 48 49```toml 50taxonomies = [ 51 # You can enable/disable RSS 52 {name = "categories", feed = true}, 53 {name = "tags", feed = true}, 54] 55``` 56If you want to paginate taxonomies pages, you will need to overwrite the templates 57as it only works for non-paginated taxonomies by default. 58 59It also requires to put the posts in the root of the `content` folder and to enable pagination, for example in `content/_index.md`: 60 61``` 62+++ 63paginate_by = 5 64sort_by = "date" 65+++ 66``` 67 68## Options 69 70### Top-menu 71Set a field in `extra` with a key of `even_menu`: 72 73```toml 74# This is the default menu 75even_menu = [ 76 {url = "$BASE_URL", name = "Home"}, 77 {url = "$BASE_URL/categories", name = "Categories"}, 78 {url = "$BASE_URL/tags", name = "Tags"}, 79 {url = "$BASE_URL/about", name = "About"}, 80] 81``` 82 83If you put `$BASE_URL` in a url, it will automatically be replaced by the actual 84site URL. 85 86### Title 87The site title is shown on the header. As it might be different from the `<title>` 88element that the `title` field in the config represents, you can set the `even_title` 89instead. 90 91### KaTeX math formula support 92 93This theme contains math formula support using [KaTeX](https://katex.org/), 94which can be enabled by setting `katex_enable = true` in the `extra` section 95of `config.toml`: 96 97```toml 98[extra] 99katex_enable = true 100``` 101 102After enabling this extension, the `katex` short code can be used in documents: 103* `{{/* katex(body="\KaTeX") */}}` to typeset a math formula inlined into a text, 104 similar to `$...$` in LaTeX 105* `{%/* katex(block=true) */%}\KaTeX{%/* end */%}` to typeset a block of math formulas, 106 similar to `$$...$$` in LaTeX 107 108#### Automatic rendering without short codes 109 110Optionally, `\\( \KaTeX \\)` inline and `\\[ \KaTeX \\]` / `$$ \KaTeX $$` 111block-style automatic rendering is also supported, if enabled in the config: 112 113```toml 114[extra] 115katex_enable = true 116katex_auto_render = true 117``` 118 119