PageFrontmatter

WARNING

Several of these properties overlap with properties on the page's RouteMeta. Properties defined on the RouteMeta take precedence over properties defined on each page's Frontmatter.

Refer to the Page Setup guide to learn about how to apply these properties.

API

Page data, defined in each MDX file's frontmatter section.

Prop	Type
title ^* The title of the page.	string
categories Override the categories used to render the breadcrumb labels. Note that this will only match up to the length of the route's path segments. If a route only has 1 path segment, and you supply 2 categories, only the first category will be accounted for.	string[]
description Page description	string
group Used for grouping pages at the same level under a common section heading.	string
hidden If true, this route will not be shown in the side navigation or adjacent routes' page links.	boolean
hideBreadcrumbs If true, the breadcrumbs will not render on this route.	boolean
hideFromSearch If true, this page's contents will not be added to the search index.	boolean
hidePageLinks If true, the page links will be hidden on this route.	boolean
hideSideNav If true, the side navigation will be hidden on this route.	boolean
hideToc If true, the table of contents be hidden on this route.	boolean
id Optional id. Used to associate the page with its entry in the _meta.json.	string
restricted If `true`, the route will be flagged as restricted. This flag does nothing internally. You will need to handle this in your application.	boolean
sideNavTitle Title for the page in the side nav. Takes precedence over title.	string
updatedBy Full name of the person who last updated the page, derived from git commit history.	string
updatedOn ISO 8601 timestamp of when the page was last updated, derived from git commit history.	string

title

Type

string

Description

The title of the page.

categories

Type

string[]

Description

Override the categories used to render the breadcrumb labels. Note that this will only match up to the length of the route's path segments. If a route only has 1 path segment, and you supply 2 categories, only the first category will be accounted for.

description

Type