title

The <h1> title of the page. This title appears at the top of the page, and in the left-hand navigation.

Note:

  • You can wrap the title text in single quotes, but this is not mandatory.
  • If you wrap the title text in single quotes, then you cannot include apostrophes in the text.

metaTitle

The <title> of the page - falls back to title (h1).

Note:

  • You can wrap the metaTitle text in single quotes, but this is not mandatory.
  • If you wrap the metaTitle text in single quotes, then you cannot include apostrophes in the text.

Specifies a different, usually shorter title for the left-hand navigation.

metaDescription

The <meta name="description" content="" /> of the page.

Note:

  • You can wrap the metaDescription text in single quotes, but this is not mandatory.
  • If you wrap the metaDescription text in single quotes, then you cannot include apostrophes in the text.

Accepts true or false (defaults to false).

If true, this option turns the page into a heading in the left-hand navigation. This heading cannot be clicked by the docs user. For example: https://www.prisma.io/docs/concepts/overview

Note: The page still exists, but docs users can only navigate to it with the breadcrumb trail. We recommend that you add a subsections MDX component to the page, so that it contains useful content when a user navigates to it with the breadcrumb trail.

preview

Accepts true or false (defaults to false).

Adds a preview label to a page in the left-hand navigation.

toc

Enable or disable table of contents navigation on the page (defaults to false). For example:

toc: true

tocDepth

Controls the depth of headings to show in the in-page ToC:

tocDepth: 2

Note: Currently limited to 2 levels - h2 and h3

hidePage

Accepts true or false (defaults to false).

Hides the page from all navigation.

hidePage: true

Note:

  • A page hidden with hidePage is not listed by the subsections MDX component.
  • A page hidden with hidePage is still findable by docs users with a search.
Edit this page on GitHub