Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/sudorook/capsule.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpseudorook <pseudorook@protonmail.com>2017-06-30 07:17:35 +0300
committerpseudorook <pseudorook@protonmail.com>2017-06-30 07:17:35 +0300
commit1dbcbd04278f7c5b640ce6c1b6a1988b473c69f4 (patch)
tree14e82a657a99f8af43bd6c6e93f6cf91623ea2ad /README.md
parent1dc542cd3069f357cd3167eb1d2972de426b1118 (diff)
add table of contents info to readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1b65def..dfdf8a3 100644
--- a/README.md
+++ b/README.md
@@ -94,6 +94,17 @@ Any CSS or JS specified here will add to the site \<head\> when hugo renders
the page.
+### 6. Enable table of contents
+
+To generate a table of contents for a specific page, add to the toml header:
+```
+toc = true
+```
+
+The table of contents will contain all the header items defined in the
+markdown. The nesting levels for each match the header weight (h1, h2, etc.).
+
+
# Build
To (re)build the CSS, you need to have npm and gulp installed. Clone the