Конфигурация метаданных

Метаданные обеспечивают настройку отдельных страниц. В каждом файле Markdown можно использовать метаданные, чтобы переопределить параметры конфигурации сайта или темы. Кроме того, есть параметры конфигурации, которые можно задать только через метаданные.

Пример использования:

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

Вы можете получить доступ к метаданным через глобальный объект $frontmatter в выражениях Vue:

{{ $frontmatter.title }}

title

• Тип: string

Заголовок страницы. Это то же самое, что config.title, и оно переопределяет конфигурацию сайта.

---
title: VitePress
---

titleTemplate

• Тип: string | boolean

Суффикс для названия. Это то же самое, что и config.titleTemplate, и оно переопределяет конфигурацию сайта.

---
title: VitePress
titleTemplate: Генератор статических сайтов на основе Vite и Vue
---

description

• Тип: string

Описание для страницы. Это то же самое, что и config.description, и оно переопределяет конфигурацию сайта.

---
description: VitePress
---

head

• Тип: HeadConfig[]

Укажите дополнительные теги, которые будут выводиться для текущей страницы. Они будут добавляться после других тегов внутри блока head, введённых в конфигурации сайта.

---
head:
  - - meta
    - name: description
      content: привет
  - - meta
    - name: keywords
      content: супер-пупер SEO
---

type HeadConfig =
  | [string, Record<string, string>]
  | [string, Record<string, string>, string]

Только для темы по умолчанию

Следующие параметры метаданных применимы только при использовании темы по умолчанию.

layout

• Тип: doc | home | page
• По умолчанию: doc

Определяет макет страницы.

• doc - Применяет стили документации по умолчанию к содержимому Markdown.
• home - Вы можете добавить дополнительные параметры, такие как hero и features, чтобы быстро создать красивую целевую страницу.
• page - Ведет себя аналогично doc, но не применяет стили к содержимому. Полезно, если вы хотите создать полностью настраиваемую страницу.

---
layout: doc
---

hero только для страниц с макетом home

Определяет содержимое секции hero, когда layout имеет значение home. Подробнее в главе Тема по умолчанию: Главная страница.

features только для страниц с макетом home

Определяет элементы для отображения в секции features, когда layout имеет значение home. Подробнее в главе Тема по умолчанию: Главная страница.

navbar

• Тип: boolean
• По умолчанию: true

Отображать ли панель навигации.

---
navbar: false
---

sidebar

• Тип: boolean
• По умолчанию: true

Отображать ли сайдбар.

---
sidebar: false
---

aside

• Тип: boolean | 'left'
• По умолчанию: true

Определяет расположение компонента aside в макете doc.

Установка этого значения в false предотвращает отрисовку контейнера сайдбара.
Установка этого значения в true приведёт к отображению сайдбара справа.
Установка этого значения в left приведёт к отображению сайдбара слева.

---
aside: false
---

outline

• Тип: number | [number, number] | 'deep' | false
• По умолчанию: 2

Уровни заголовков в оглавлении для отображения на странице. Это то же самое, что и config.themeConfig.outline.level, и оно переопределяет значение, установленное в конфигурации сайта.

---
outline: [2, 4]
---

lastUpdated

• Тип: boolean | Date
• По умолчанию: true

Отображать ли текст Обновлено в футере текущей страницы. Если указано время даты, оно будет отображаться вместо временной метки последнего изменения git.

---
lastUpdated: false
---

editLink

• Тип: boolean
• По умолчанию: true

Отображать ли ссылку для редактирования в футере текущей страницы.

---
editLink: false
---

footer

• Тип: boolean
• По умолчанию: true

Отображать ли футер.

---
footer: false
---

pageClass

• Тип: string

Добавьте дополнительное имя класса на определённую страницу.

---
pageClass: custom-page-class
---

Вы также можете настроить стили этой конкретной страницы в файле .vitepress/theme/custom.css:

.custom-page-class {
  /* стили для конкретной страницы */
}

isHome

• Тип: boolean

Стандартная тема полагается на проверки типа frontmatter.layout === 'home', чтобы определить, является ли текущая страница домашней (главной).
Это полезно, когда вы хотите принудительно показывать элементы домашней страницы в пользовательском макете.

---
isHome: true
---