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.
| Key | Type | Default |
|---|---|---|
title | string |
---
title: Awesome Project
---
description#
Sets the metadata description of the document and is also used on any social Open Graph & Twitter tags.
| Key | Type | Default |
|---|---|---|
description | string |
---
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).
| Key | Type | Default |
|---|---|---|
image | string |
---
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.
| Key | Type | Default |
|---|---|---|
redirect | string |
index.md
---
redirect: /getting-started
redirect: https://github.com/acme/awesome-project
---