diff options
| author | Olivier DOSSMANN <git@dossmann.net> | 2020-07-22 21:42:45 +0300 |
|---|---|---|
| committer | Olivier DOSSMANN <git@dossmann.net> | 2020-07-22 22:01:54 +0300 |
| commit | 4e014f1d44ca45172f7f3fbd9c8cbc4c7e6a6ab0 (patch) | |
| tree | b600d039c9784b0014e207d18b0b70e25330d0dd | |
| parent | 8e6c7d1d44373161c0e0aa88611380df81c4ef6a (diff) | |
Fix #10 - add more documentation about table of content
| -rw-r--r-- | README.md | 18 | ||||
| -rw-r--r-- | config.toml.example | 5 | ||||
| -rw-r--r-- | exampleSite/config.toml | 6 |
3 files changed, 29 insertions, 0 deletions
@@ -44,6 +44,24 @@ git clone https://github.com/blankoworld/hugo_theme_adam_eve.git Check [Hugo Installation Guide](https://gohugo.io/getting-started/installing/) for more information. +## Configuration + +It's hardly recommended to check the `config.toml.example` file. Especially to configure the table of content via `[markup]` section, the name of each menu and some other example. + +### Table of content + +To configure the table of content, edit your `config.toml` file and add something like: + +```toml +[markup] + [markup.tableOfContents] + endLevel = 6 + ordered = false + startLevel = 1 +``` + +It means you start the Table of Content from `h1` to `h6`. You can find [more info about table of content configuration on official Hugo documentation](https://gohugo.io/getting-started/configuration-markup/#table-of-contents). + ## Getting Started ### The config file diff --git a/config.toml.example b/config.toml.example index e1d1ac0..be710a0 100644 --- a/config.toml.example +++ b/config.toml.example @@ -31,3 +31,8 @@ description = "Sharing knowledge wiki" identifier = "homepage" url = "/" +[markup] + [markup.tableOfContents] + endLevel = 6 + ordered = false + startLevel = 1 diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 5443043..373abb7 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -17,3 +17,9 @@ description = "Des poissons et de l'eau" [Languages.en.params] description = "Fish and water" + +[markup] + [markup.tableOfContents] + endLevel = 6 + ordered = false + startLevel = 1 |