Frontmatter

Использование

VitePress поддерживает YAML frontmatter во всех файлах Markdown, анализируя их с помощью gray-matter. Frontmatter должен находиться в верхней части файла Markdown (до любых элементов, включая теги <script>), и должен быть представлен в виде допустимого YAML кода, заключённого между тройными черточками. Пример:

---
title: Документация с VitePress
editLink: true
---

Многие опции конфигурации сайта или темы по умолчанию имеют соответствующие опции в frontmatter. Вы можете использовать frontmatter для переопределения конкретного поведения только для текущей страницы. Для подробностей смотрите Справочник по конфигурации Frontmatter.

Вы также можете определить собственные пользовательские данные frontmatter, которые будут использоваться в динамических Vue выражениях на странице.

Доступ к данным Frontmatter

Данные frontmatter можно получить через специальную глобальную переменную $frontmatter:

Вот пример того, как вы могли бы использовать это в вашем файле Markdown:

---
title: Документация с VitePress
editLink: true
---

# Frontmatter

Контент руководства

Вы также можете получить доступ к данным frontmatter текущей страницы в <script setup> с помощью помощника useData().

Альтернативные форматы Frontmatter

VitePress также поддерживает синтаксис frontmatter JSON, начинающийся и заканчивающийся фигурными скобками:

---
{
  "title": "Блоггинг как хакер",
  "editLink": true
}
---