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.

Example
---
title: Welcome to Awesome Project
description: Some awesome docs!
---

# Welcome!

title

Sets the metadata title of the document and is also used on any social Open Graph & Twitter tags.

KeyTypeDefault
titlestring
---
title: Awesome Project
---

description

Sets the metadata description of the document and is also used on any social Open Graph & Twitter tags.

KeyTypeDefault
descriptionstring
---
description: An awesome description about my Awesome Project.
---

image

A URL which points to an image used as the social preview. Fallback to the config.socialPreview (if one is set).

KeyTypeDefault
imagestring
---
image: https://mycdn.com/foo.png
---

redirect

A path which if set, will instantly redirect the user. If set, none of the other frontmatter or Markdown on the page will be shown/processed.

Can be a relative internal path or external URL.

KeyTypeDefault
redirectstring
index.md
---
redirect: /getting-started
redirect: https://github.com/acme/awesome-project
---

previous

A path which if set, will show a link to the previous page at the bottom of the page. If the previousTitle is not set, the title will be get from the docs.json. If not found in the configuration file, an empty string will be used.

Can be a relative internal path or external URL.

KeyTypeDefault
previousstring
previousTitlestringThe value for the previous path in the docs.json file
index.md
---
previous: /getting-started
previousTitle: Getting started
---

next

A path which if set, will show a link to the next page at the bottom of the page. If the nextTitle is not set, the title will be get from the docs.json. If not found in the configuration file, an empty string will be used.

Can be a relative internal path or external URL.

KeyTypeDefault
nextstring
nextTitlestringThe value for the next path in the docs.json file
index.md
---
next: /getting-started
nextTitle: Getting started
---