Geekdocs
GitHub Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

ToC-Tree

The toc-tree shortcode will generate a Table of Content from a section file tree of your content directory. The root of the resulting ToC will be the page on which you define the shortcode.

Usage

{{< toc-tree [sortBy="title"] >}}

Attributes

sortBy optional string
Override the default sort parameter set by geekdocFileTreeSortBy.
Default: .Site.Params.geekdocFileTreeSortBy

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 section.