enableToc

Warning

This configuration option is deprecated in favor of toc starting with version 1.1.0-beta.47 of the Portal.

We strongly recommend updating your configuration to avoid portal build failures.

Usage

When set to true, displays a table of contents (ToC) on the right side of each MD(X) page.

  • To modify all pages in the portal, add it to the top level of the siteConfig.yaml file.
  • To override the site-wide configuration, add it to the front matter of specific MD(X) pages.

Read more about ToC configuration.

Examples

In siteConfigIn front matter
Copy
Copied
meta:
  title: Example Developer Portal
  description: Learn how to work with Example APIs
enableToc: true
Copy
Copied
---
title: Markdown example
description: GitHub-flavored Markdown example
enableToc: false
---

Example text