Builder

@doc-tools/docs — пакет для сборки документационного проекта: с навигацией, внутренними переходами и полной поддержкой Yandex Flavored Markdown.

Собранный проект представляет собой набор статических HTML, которые можно просмотреть локально или разместить на хостинге, в GitHub Pages или S3.

Установка

Чтобы установить пакет, выполните команду:

npm i @doc-tools/docs -g

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

Пакет предоставляет команду yfm интерфейса командной строки.

Чтобы запустить сборку, выполните команду, указав обязательные ключи запуска:

  • --input, -i — путь до директории проекта.
  • --output, -o — путь до директории, предназначенной для выходных данных (статических HTML).
yfm -i ./input-folder -o ./ouput-folder