english | русский
yfm-docs
Yfm-docs lets you build a full-fledged documentation project: with navigation, internal transitions, and full
Yandex Flavored Markdown (YFM) support.
Documentation
ydocs.tech
Usage
npm i @diplodoc/cli -g
npm run start -- -i ./input-folder -o ./ouput-folder -v "{\"name\":\"Alice\"}"
Source files
Preparation
You need to add .env
file into repo root with data below:
GITHUB_OWNER=
GITHUB_REPO=
GITHUB_TOKEN=
GITHUB_BASE_URL=
VCS_CONNECTOR_TYPE=
or you can update .yfm file into docs repo
connector:
type:
github:
endpoint:
token:
owner:
repo:
Build from source
cd cli
npm ci && npm run build
License
MIT