Table of Contents – ZM Blog

New param (since 2020-02-13)

I added new param named tocLevels. Sometimes toc doesn’t work well with the below config params. So I added the new param and this will fix some toc related issues.

Set tocLevels globally. In your params.toml file,
1 2

... tocLevels = ["h2", "h3", "h4"]

Set tocLevels locally. In your your post markdown file.

1
2
3
4
5
6


---
title:
date:
...
tocLevels: ["h2", "h3", "h4"]
---

So, the h2 is the minimum, h4 is the maximum toc level that used in an article.

config.toml

There are some toc related params in the config.toml file.

1
2
3
4


[markup.tableOfContents]
    endLevel = 3
    ordered = false
    startLevel = 2

You need to set this configuration parameter. Otherwise toc will malfunction. startLevel and endLevel means that you use at maximum ## , and at minimum, ### for the title of the post.

params.toml

You can set the toc related params at params.toml file for the global.

hideToc - Hide the toc in the first place. You can toggle the switch to show the toc later .
enableToc - Toc disapear entirely in all posts.
toc - Toc disapear entirely in all posts. This is Alias to enableToc
enableTocContent - Toc in the main article, not in sidebar.
tocPosition: When inner, toc will be inside the border. When outer, toc will be outside of the border

front matter

You can set toc params for each post, by setting front matter. So basically, each post can have it’s own toc params that override global config.

1
2
3
4
5
6
7
8
9


---
title: myPost
date: 2020-01-30
hideToc:
enableToc:
enableTocContent:
tocPosition:
...
---