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

github.com/nodejh/hugo-theme-cactus-plus.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornodejh <jianghangscu@gmail.com>2021-08-16 10:35:10 +0300
committernodejh <jianghangscu@gmail.com>2021-08-16 10:35:10 +0300
commitcbe158b00a2676697527ffdf8d5e10cdd4f7de6a (patch)
treed7072e4cfb50b4dfc778d84cb18f98873d55cfd7 /README.md
parent82e53f4acd1ea91f80776053c79d18722883ab29 (diff)
feat: support table of content
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/README.md b/README.md
index 75edd12..74b47e9 100644
--- a/README.md
+++ b/README.md
@@ -132,9 +132,19 @@ hugo
```
-## 3. Optional
+## 3. Optional Configuration
-### 3.1 Disable Comments on a single post
+### 3.1 Table of Content
+
+To enable table of content, you could set `showToc` to `true`.
+
+For example:
+
+```yaml
+showToc: true
+```
+
+### 3.2 Disable Comments on a single post
You can set `enableComments` to `false` in front matter to disable disqus comments on a single post.
@@ -147,7 +157,7 @@ enableComments: false
---
```
-### 3.2 Custom CSS and JS
+### 3.3 Custom CSS and JS
You can put your custom css and js files to `static` directory, or use remote css and js files which start with `http://` or `https://`.
@@ -162,7 +172,7 @@ customJS:
- https://example.com/custom.js # remote js
```
-### 3.3 Math Typesetting
+### 3.4 Math Typesetting
Mathematical notation is enabled by [KaTeX](https://katex.org/).