Table of Contents
Generate a table of contents for your pages.
The TableOfContents extension generates a table of contents for your pages based on the headings in the content.
Content like this:
# Documentation
## Introduction
...
### Features
...
## Getting Started
### Installation
...
### Configuration
...
Will generate a table of contents like this:
- Introduction
- Features
- Getting Started
- Installation
- Configuration
Usage
To use the TableOfContentsExtension, add it to the extensions list of the ContentApp component:
ContentApp(
...
extensions: [
TableOfContentsExtension(),
],
);
The extension takes the following properties to customize the behavior:
maxHeaderDepthintThe maximum header depth to include in the table of contents. Defaults to 3.
The extension does not render anything by default. Instead the generated TableOfContents object is stored in the page's data under the 'toc' key. It may then be consumed by a layout to display the table of contents.
For example, the DocsLayout uses the TableOfContents object to render a table of contents in the sidebar.