Начало работы
ПРИМЕЧАНИЕ СОВМЕСТИМОСТИ
VuePress для работы требуется Node.js >= 8.
Глобальная установка
Если хотите просто поиграться с VuePress, вы можете установить его глобально:
# устанавливаем глобально
yarn global add vuepress # ИЛИ npm install -g vuepress
# создаём markdown-файл
echo '# Hello VuePress' > README.md
# начинаем писать
vuepress dev
# собираем
vuepress build
Добавление в существующий проект
Если у вас уже есть существующий проект и вы хотите оставить документацию внутри него, то вы должны установить VuePress локальной зависимостью. Эта конфигурация также позволит вам использовать CI или сервисы, такие как Netlify, для автоматической публикации при изменениях.
# устанавливаем как локальную зависимость проекта
yarn add -D vuepress # ИЛИ npm install -D vuepress
# создаём каталог docs
mkdir docs
# создаём markdown-файл
echo '# Hello VuePress' > docs/README.md
ВНИМАНИЕ
В настоящее время рекомендуется использовать Yarn вместо NPM при установке VuePress в существующий проект, где уже есть webpack 3.x в качестве зависимости. NPM не может сгенерировать правильное дерево зависимостей в данном случае.
Затем добавляем команды в package.json:
{
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
}
Теперь вы можете начинать писать:
yarn docs:dev # ИЛИ npm run docs:dev
Чтобы сгенерировать статичные файлы запустите:
yarn docs:build # ИЛИ npm run docs:build
По умолчанию собранные файлы располагаются в .vuepress/dist, что может быть изменено с помощью опции dest в файле .vuepress/config.js. Готовые файлы можно опубликовать на любом статическом файловом сервере. В руководстве по публикации можно изучить подробнее как публиковать на популярные сервисы.