add documentation for toc and toc-tree shortcode

uci-hugo-doc
Robert Kaussow 2020-02-16 23:39:23 +01:00
parent 0019007a37
commit d9fc5a22b5
2 changed files with 26 additions and 0 deletions

View File

@ -0,0 +1,9 @@
The toc-tree shortcode will generate a Table of Content from a section filetree of your content directory. The root of the resulting ToC will be the page on which you define the shortcode.
```tpl
{{</* toc-tree */>}}
```
## Example
As said, the root will be the site on which the shortcode was used, you can see a demo including nesting in the [ToC Tree](/toc-tree) section.

View File

@ -0,0 +1,17 @@
Simple wrapper to generate a page Table of Content from a shortcode.
```tpl
{{</* toc */>}}
```
{{< toc >}}
## Level 1
## Level 2
### Level 2.1
### Level 2.2