1
0
silverbullet/website/Table of Contents.md
Zef Hemel f30b1d3418
Templates 2.0 (#636)
Templates 2.0 and a whole bunch of other refactoring
2024-01-20 19:16:07 +01:00

28 lines
1.2 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

You can add a table of contents to a page using `toc` [[Blocks]].
In its most basic form it looks like this (click the edit button to see the code):
```toc
```
You can use it in two ways:
1. _Manually_, by adding a `toc` widget to the pages where youd like to render a ToC
2. _Automatically_, using a [[Live Template Widgets|Live Template Widget]]
To have a ToC added to all pages with a larger (e.g. 3) number of headings, it is recommended to use [[Library/Core/Widget/Table of Contents|this template widget]].
## Configuration
In the body of the `toc` code widget you can configure a few options:
* `header`: by default a “Table of Contents” header is added to the ToC, set this to `false` to disable rendering this header
* `minHeaders`: only renders a ToC if the number of headers in the current page exceeds this number, otherwise renders an empty widget
* `maxHeaders`: only renders a ToC if the number of headers in the current page is below this number, otherwise renders an empty widget
Example:
```toc
header: false
minHeaders: 1
```
Want to add a table of contents to all your pages automatically? You can — thats functionality available via the [[Library/Core]] library.