NavConfig

Page data is defined in the config's navConfig field. Properties for this field are documented here.

WARNING

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

The NavConfig type is a union of two types:

export type NavConfig = RouteMeta | NavMeta

API

RouteMeta

Metadata that describes a route.

Prop	Type	Default
id ^* The path segment for this route.	string
children Nested routes.	RouteMeta[]
expanded If `true`, the side nav item will be expanded on initial load. Does nothing if the entry is a leaf node.	boolean
group Used for grouping pages at the same level under a common section heading.	string
groupOrder Order for the groups within this item's hierarchy.	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
ignoreRouteMetaOrder By default, pages with a RouteMeta are ordered before pages that are not defined. Set this property to `true` to disable that behavior.	boolean	false
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
sectionTitle This property is only available for top-level items.	never
separator This property is only available for top-level items.	never
sideNavTitle Title for the page in the side nav. Takes precedence over title.	string
title The title of the item in the side nav. Will be parsed from the page's frontmatter if it is not defined in the RouteMeta.	string