import{_ as e,c as a,o as n,a as t}from"./app.54944ef9.js";const f='{"title":"Frontmatter","description":"","frontmatter":{},"headers":[{"level":2,"title":"Alternative frontmatter Formats","slug":"alternative-frontmatter-formats"},{"level":2,"title":"Predefined Variables","slug":"predefined-variables"},{"level":3,"title":"title","slug":"title"},{"level":3,"title":"head","slug":"head"},{"level":3,"title":"navbar","slug":"navbar"},{"level":3,"title":"sidebar","slug":"sidebar"},{"level":3,"title":"editLink","slug":"editlink"}],"relativePath":"guide/frontmatter.md","lastUpdated":1652768268000}',s={},o=t(`
Any Markdown file that contains a YAML frontmatter block will be processed by 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:
---
title: Docs with VitePress
editLink: true
---
Between the triple-dashed lines, you can set predefined variables, or even create custom ones of your own. These variables can be used via the special $frontmatter
variable.
Here\u2019s an example of how you could use it in your Markdown file:
---
title: Docs with VitePress
editLink: true
---
# {{ $frontmatter.title }}
Guide content
VitePress also supports JSON frontmatter syntax, starting and ending in curly braces:
---
{
"title": "Blogging Like a Hacker",
"editLink": true
}
---
string
h1_title || siteData.title
Title of the current page.
array
undefined
Specify extra head tags to be injected:
---
head:
- - meta
- name: description
content: hello
- - meta
- name: keywords
content: super duper SEO
---
boolean
undefined
You can disable the navbar on a specific page with navbar: false
boolean|'auto'
undefined
You can decide to show the sidebar on a specific page with sidebar: auto
or disable it with sidebar: false
boolean
undefined
Define if this page should include an edit link.
`,26),i=[o];function l(r,p,c,d,u,h){return n(),a("div",null,i)}var m=e(s,[["render",l]]);export{f as __pageData,m as default};