Skip to content

Clarify use of interpolations inside Markdown headings #4844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify use of interpolations inside Markdown headings #4844

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/en/reference/frontmatter-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,19 @@ You can access frontmatter data via the `$frontmatter` global in Vue expressions
{{ $frontmatter.title }}
```

However, avoid using a Vue expression in this manner inside Markdown headings:

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

# {{ $frontmatter.title }}
```

The heading's anchor and accessibility attributes, as well as search index contents, are produced **before** Vue evaluates the expression, which will result in the string `frontmatter-title` being used in those places instead of the actual title.

## title

- Type: `string`
Expand Down