toc section to control the behavior of page table of contents (TOC) in Markdown and MDX pages. Add it to the top level of the
siteConfig.yaml file and configure supported options inside it.
Some of the options can be used in the front matter of MD(X) pages to override the site-wide configuration. Read more about ToC configuration.
When enabled, the page TOC is displayed on the right side of each MD(X) page. Note that the first H1 heading on a page is never included in the TOC. Any subsequent H1 headings are included.
||When set to
||This option is dependent on and related to
seo: title: Example Developer Portal description: Learn how to work with Example APIs toc: enable: true maxDepth: 2
--- seo: title: Markdown example description: GitHub-flavored Markdown example toc: enable: false --- Example text