Page metadata
Some properties for your pages.
Each page can have some frontmatter metadata at the top, which includes information about the page. The following properties can be included:
title
- The title of the page. Docs without a title will never be shown in the sidebar or search.description
- A short description of the page, which will appear below the title.category
- Optional ID of the category this page belongs to. If not defined, the page is uncategorized. More infoshowTitle
- Whether or not to show the page's title and description at its top. By default it'strue
.showToc
- Whether or not to show the page's table of contents on the side. By default it'strue
.showPagination
- Whether or not to show the next and previous page buttons at the bottom of the page. By default it'strue
.showSidebar
- Whether or not to show the sidebar when this page is viewed. By default it'strue
.includeInSidebar
- Whether or not to include this page as an item in the sidebar and search. By default it'strue
.
Example page metadata
docs/installation.mdx
---
title: Installation
description: How to install PROJECT_NAME in your app.
category: getting-started
---
More example pages can be found in the content/sample/
directory of this site.