Frontmatter
Learn about configuring your documentation pages with frontmatter.
Frontmatter is a way to customize metadata of a page directly within your Markdown files. The metadata properties can be added to Markdown pages by adding frontmatter blocks to the top of any page.
---
title: Welcome to Awesome Project
description: Some awesome docs!
---
# Welcome!
Frontmatter overrides any default properties set in the project configuration file. This allows you to customize each page with unique metadata.
Properties
Below is a list of all available frontmatter properties, their type and default values.
titlestringThe title of the page used in metadata, and social cards and as a page heading title.
descriptionstringThe description of the page used in metadata.
imagestringAn Asset URL to an image used in social cards and shown at the top of the page if showPageImage is true.
redirectstringA URL to redirect to when the page is visited. Setting this value overrides the page content.
showPageTitlebooleanWhether to show the title as a heading title at the top of the page.
showPageImagebooleanWhether to show the image at the top of the page.
noindexbooleanIf true, the page will be excluded from search engines.
previousstringA path which if set, will show a link to the previous page at the bottom of the page.
Use with previousTitle:
---
previous: /getting-started
previousTitle: Getting started
---
nextstringA path which if set, will show a link to the next page at the bottom of the page.
Use with nextTitle:
---
next: /getting-started
nextTitle: Getting started
---