mirror of https://github.com/vuejs/vitepress
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
39 lines
945 B
39 lines
945 B
# Frontmatter
|
|
|
|
Any Markdown file that contains a YAML frontmatter block will be processed by [gray-matter](https://github.com/jonschlinkert/gray-matter). The frontmatter must be at the top of the Markdown file, and must take the form of valid YAML set between triple-dashed lines. Example:
|
|
|
|
```md
|
|
---
|
|
title: Docs with VitePress
|
|
editLink: true
|
|
---
|
|
```
|
|
|
|
Between the triple-dashed lines, you can set [predefined variables](../config/frontmatter-config), or even create custom ones of your own. These variables can be used via the special <code>$frontmatter</code> variable.
|
|
|
|
Here's an example of how you could use it in your Markdown file:
|
|
|
|
```md
|
|
---
|
|
title: Docs with VitePress
|
|
editLink: true
|
|
---
|
|
|
|
# {{ $frontmatter.title }}
|
|
|
|
Guide content
|
|
```
|
|
|
|
## Alternative Frontmatter Formats
|
|
|
|
VitePress also supports JSON frontmatter syntax, starting and ending in curly braces:
|
|
|
|
```json
|
|
---
|
|
{
|
|
"title": "Blogging Like a Hacker",
|
|
"editLink": true
|
|
}
|
|
---
|
|
```
|