Развертывание

Vue Styleguidist умеет собирать документацию в статический сайт. В этом В разделе показан вариант публикации через GitHub Pages.

Подготовка

Сначала укажите директорию сборки сайта через опцию styleguideDir. По умолчанию используется папка styleguide рядом с styleguide.config.js.

Выполните:

pnpm predocs
pnpm docs:build

После этого готовые статические файлы будут в docs/dist.

Развертывание на страницах GitHub

Удобнее всего использовать действия GitHub:

1. Клонировать репозитории и хранить в зависимости от (pnpm install).
2. Собрать документацию:

pnpm predocs
pnpm docs:build

3. Опубликовать docs/dist на страницах GitHub.

Если вы дополнительно собираете фрагменты руководства по стилю, скопируйте их в docs/dist до шага публикации (в этой репозитории это уже сделано в CI).

Ручная публикация (резервный вариант)

При необходимости можно собрать и опубликовать вручную:

pnpm predocs
pnpm docs:build

Затем загрузите docs/dist в целевую ветку GitHub Pages.