Frontmatter
For every markdown page, you have to add frontmatter. Otherwise, the build will fail.
Variables | Description |
---|---|
title |
Sets the title of the homepage and is also used for Open Graph (OG) embeds when sharing links. |
description |
Defines the OG description, though it is currently unused. It also works as a description for link embeds unless customDescription is specified. |
customDescription |
Overrides the default OG description, providing a custom description for link embeds. |
outline |
Determines the header levels shown in the outline. The default is 2 , but you can specify a range, e.g., [2,3] , to include multiple levels. |
og |
Specifies a custom image for the OG link embed. By default, it uses the image set in docs\.vitepress\configs\hooks\opengraph.ts . If a custom OG image is needed for a specific page, it should be added in the front matter. The required resolution is 1800x900 . |