Frontmatter Config ​

Frontmatter enables page based configuration. In every markdown file, you can use frontmatter config to override site-level or theme-level config options. Also, there are config options which you can only define in frontmatter.

Example usage:

---
title: Docs with VitePress
editLink: true
---

You can access frontmatter data via the $frontmatter global in Vue expressions:

{{ $frontmatter.title }}

title ​

• Type: string

Title for the page. It's same as config.title, and it overrides the site-level config.

---
title: VitePress
---

titleTemplate ​

• Type: string | boolean

The suffix for the title. It's same as config.titleTemplate, and it overrides the site-level config.

---
title: VitePress
titleTemplate: Vite & Vue powered static site generator
---

description ​

• Type: string

Description for the page. It's same as config.description, and it overrides the site-level config.

---
description: VitePress
---

head ​

• Type: HeadConfig[]

Specify extra head tags to be injected for the current page. Will be appended after head tags injected by site-level config.

---
head:
  - - meta
    - name: description
      content: hello
  - - meta
    - name: keywords
      content: super duper SEO
---

type HeadConfig =
  | [string, Record<string, string>]
  | [string, Record<string, string>, string]

Default Theme Only ​

The following frontmatter options are only applicable when using the default theme.

layout default theme only ​

• Type: doc | home | page
• Default: doc

Determines the layout of the page.

• doc - It applies default documentation styles to the markdown content.
• home - Special layout for "Home Page". You may add extra options such as hero and features to rapidly create beautiful landing page.
• page - Behave similar to doc but it applies no styles to the content. Useful when you want to create a fully custom page.

---
layout: doc
---

hero default theme only Home page only ​

Defines contents of home hero section when layout is set to home. More details in Default Theme: Home Page.

features default theme only Home page only ​

Defines items to display in features section when layout is set to home. More details in Default Theme: Home Page.

aside default theme only ​

• Type: boolean
• Default: true

If you want the right aside component in doc layout not to be shown, set this option to false.

---
aside: false
---

outline default theme only ​

• Type: number | [number, number] | 'deep' | false
• Default: 2

The levels of header in the outline to display for the page. It's same as config.themeConfig.outline, and it overrides the theme config.

lastUpdated default theme only ​

• Type: boolean
• Default: true

Whether to display Last Updated text in the footer of the current page.

---
lastUpdated: false
---

editLink default theme only ​

• Type: boolean
• Default: true

Whether to display Edit Link in the footer of the current page.

---
editLink: false
---