русский | english

yfm-docs

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

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

ydocs.tech

Требования

Node 22+

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

npm i @diplodoc/cli -g

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

yfm init

Инициализация нового проекта документации Diplodoc.

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

yfm init [options]

Запуск без флагов в терминале запускает интерактивный визард. Передайте --skip-interactive чтобы использовать флаги и дефолтные значения.

Опции

| Опция | По умолчанию | Описание | | ------------------------- | ------------------- | --------------------------------------------- | | -o, --output <path> | . | Директория для создания проекта | | --name <string> | basename директории | Название проекта | | --langs <string> | en | Языки через запятую, например en,ru | | --default-lang <string> | первый из --langs | Язык по умолчанию | | --template <string> | minimal | minimal или full | | --header | true | Навигационная шапка в toc.yaml | | --force | false | Перезаписать существующую директорию | | --dry-run | false | Показать что будет создано, без записи файлов | | --skip-interactive | false | Пропустить визард |

Создаваемые файлы

minimal

<output>/
├── .yfm
├── toc.yaml
└── index.md

full — дополнительно создаёт presets.yaml, pc.yaml и расширенный .yfm с конфигурацией pdf, search, vcs, authors.

Для многоязычных проектов (--langs en,ru) контент размещается в поддиректориях по языку:

<output>/
├── .yfm
├── presets.yaml
├── en/
│   ├── toc.yaml
│   └── index.md
└── ru/
    ├── toc.yaml
    └── index.md

Исходники

Подготовка

Необходимо добавить .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