README.ru.md

русский | english

---

yfm-docs

Yfm-docs позволяет собрать полноценный документационный проект: с навигацией, внутренними переходами и полной поддержкой Yandex Flavored Markdown (YFM).

Документация

ydocs.tech

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

npm i @diplodoc/cli -g

npm run start -- -i ./input-folder -o ./ouput-folder -v "{\"name\":\"Alice\"}"

Исходники

Подготовка

Необходимо добавить .env файл в рут репозитория с данными ниже:

GITHUB_OWNER=
GITHUB_REPO= # docs
GITHUB_TOKEN= # personal access token
GITHUB_BASE_URL= # for ex: https://api.github.com
VCS_CONNECTOR_TYPE= # github

или обновить .yfm файл в docs репозитории:

connector:
    type:
    github:
        endpoint:
        token:
        owner:
        repo:

Сборка из исходников

cd cli
npm ci && npm run build

License

MIT