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
---
# 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
---

tableOfContents#

Whether the table of contents for this page will be shown alongside the content.

KeyTypeDefault
tableOfContentsbooleantrue
---
tableOfContents: false
---

layout#

The layout type this page will be rendered with, can be one of default, wide or full.

KeyTypeDefault
layoutLayout'default'
LayoutWidth
default72rem
wide80rem
full100%
---
layout: full
---

Whether the sidebar (if provided in your docs.json) will show for this page.

KeyTypeDefault
sidebarbooleantrue
---
sidebar: false
---

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 internal path or external URL.

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