Between the triple-dashed lines, you can set [predefined variables](#predefined-variables), or even create custom ones of your own. These variables can be used via the <code>\$frontmatter</code> variable.
Between the triple-dashed lines, you can set [predefined variables](#predefined-variables), or even create custom ones of your own. These variables can be used via the <code>$frontmatter</code> variable.
Here’s an example of how you could use it in your Markdown file:
Here’s an example of how you could use it in your Markdown file:
In VitePress, some core [computed properties](https://v3.vuejs.org/guide/computed.html#computed-properties) can be used by the default theme or custom themes. Or directly in Markdown pages using vue, for example using `{{ $frontmatter.title }}` to access the title defined in the frontmatter section of the page.
In VitePress, some core [computed properties](https://v3.vuejs.org/guide/computed.html#computed-properties) can be used by the default theme or custom themes. Or directly in Markdown pages using vue, for example using `$frontmatter.title` to access the title defined in the frontmatter section of the page.
## $site
## $site
This is the `$site` value of the site you’re currently reading:
This is the `$site` value of the site you're currently reading:
```json
```js
{
{
"title": "VitePress",
base: '/',
"description": "Vite & Vue powered static site generator.",
lang: 'en-US',
"lang": "en-US",
title: 'VitePress',
"locales": {},
description: 'Vite & Vue powered static site generator.',
"base": "/",
head: [],
"head": [],
locales: {},
"themeConfig: $themeConfig
themeConfig: $themeConfig
}
```
## $themeConfig
Refers to `$site.themeConfig`.
```js
{
locales: {},
repo: 'vuejs/vitepress',
docsDir: 'docs',
editLinks: true,
editLinkText: 'Edit this page on GitHub',
lastUpdated: 'Last Updated',
nav: [...],
sidebar: { ... }
}
}
```
```
## $page
## $page
This is the `$page` value of the page you’re currently reading:
This is the `$page` value of the page you're currently reading:
```json
```js
{
{
"title": "Global Computed",
relativePath: 'guide/global-computed.md',
"relativePath": "guide/global-computed.md",
title: 'Global Computed',
"lastUpdated": 1606297645000
headers: [
"headers": [
{ level: 2, title: '$site', slug: 'site' },
{
{ level: 2, title: '$page', slug: '$page' },
"level": 2,
"title": "$site",
"slug": "site"
},
{
"level": 2,
"title": "$page",
"slug": "$page"
},
...
...
],
],
"frontmatter": $frontmatter,
frontmatter: $frontmatter,
lastUpdated: 1606297645000
}
}
```
```
## $frontmatter
## $frontmatter
Reference of [$page](#page).frontmatter.
Reference of `$page.frontmatter`.
```json
```js
{
{
"title": "Docs with VitePress",
title: 'Docs with VitePress',
"editLink": true
editLink: true
}
}
```
```
@ -62,52 +71,3 @@ Value of the `<title>` label used for the current page.
## $description
## $description
The content value of the `<meta name= "description" content= "...">` for the current page.
The content value of the `<meta name= "description" content= "...">` for the current page.