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

ToC

Simple wrapper to generate a page Table of Content from a shortcode.

Usage

{{< toc (format=[html|raw]) >}}

Attributes

format optional string
Format of the returned ToC. The html format creates an HTML wrapper to enable the geekdocToC parameter that limits the maximum ToC level to be displayed. This variant also automatically inserts a horizontal line after the ToC. The raw format returns the unformatted ToC, the parameter geekdocToC does not work in this mode. Supported values are html|raw.
Default: html

Example

Level 1

Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious copious quo ad. Stet probates in duo.

Level 2

Amalia id per in minimum facility, quid facet modifier ea ma. Ill um select ma ad, en ferric patine sentient vim. Per expendable foreordained interpretations cu, maxim sole pertinacity in ram.

Level 2.1

Amalia id per in minimum facility, quid facet modifier ea ma. Ill um select ma ad, en ferric patine sentient vim. Per expendable foreordained interpretations cu, maxim sole pertinacity in ram.

Level 2.1.1

Amalia id per in minimum facility, quid facet modifier ea ma. Ill um select ma ad, en ferric patine sentient vim.

Level 2.1.1.1

In pro quints consequent, denim fastidious copious quo ad.

Level 2.1.1.1.1

In pro quints consequent, denim fastidious copious quo ad.

Level 2.2

Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e.

Amalia id per in minimum facility, quid facet modifier ea ma. Ill um select ma ad, en ferric patine sentient vim. Per expendable foreordained interpretations cu, maxim sole pertinacity in ram.