Конфигурация

Файл конфигурации

Без конфигурации страницы сайта очень минималистичны, и у пользователя нет возможности перемещаться по сайту. Для настройки вашего сайта, сначала создайте каталог .vuepress внутри каталога вашей документации. Это место, где будут располагаться все файлы относящиеся к VuePress. Ваша структура проекта станет примерно такой:

.
├─ docs
│  ├─ README.md
│  └─ .vuepress
│     └─ config.js
└─ package.json

Важным файлом для конфигурации сайта VuePress является .vuepress/config.js, который должен экспортировать объект JavaScript:

module.exports = {
  title: 'Привет VuePress',
  description: 'Просто тестируем работу'
}

Если у вас запущен сервер для разработки, вы должны увидеть, что у страницы теперь есть заголовок с указанным текстом и поле поиска. VuePress поставляется с встроенным поиском по заголовкам — она автоматически создаёт простой индекс поиска из заголовков страниц, h2 и h3 заголовков со всех страниц.

Полный список опций можно изучить на странице Конфигурация.

Альтернативный формат конфигурации

Вы можете также использовать форматы YAML (.vuepress/config.yml) или TOML (.vuepress/config.toml) для файла конфигурации.

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

Тема VuePress отвечает за все шаблоны и интерактивность вашего сайта. VuePress поставляется с темой по умолчанию (вы смотрите на неё прямо сейчас), которая предназначена для технической документации. Она предоставляет ряд опций, которые позволяют вам настраивать панель навигации, боковую панель, главную страницу и т.д. Подробнее можно изучить в разделе Настройки стандартной темы.

Если вы хотите создать собственную тему, ознакомьтесь с разделом Пользовательские темы.

Доработки уровня приложения

Поскольку приложение VuePress по сути обычное приложение Vue, то вы можете применять доработки на уровне приложения создав файл .vuepress/enhanceApp.js, который будет импортирован в приложение, если присутствует. Файл должен экспортировать по умолчанию (export default) функцию-хук, которая получит объект, содержащий некоторые значения уровня приложения. Вы можете использовать этот хук для установки дополнительных плагинов Vue, регистрации глобальных компонентов, или добавления хуков маршрутизатора:

export default ({
  Vue,      // версия Vue, используемая в приложении VuePress
  options,  // настройки корневого экземпляра Vue
  router,   // экземпляр маршрутизатора приложения
  siteData  // мета-данные сайта
}) => {
  // ...применяем доработки к приложению
}
Последнее обновление: 2018-6-9 18:11:24