@diplodoc/cli
Advanced tools
english | русский
Yfm-docs lets you build a full-fledged documentation project: with navigation, internal transitions, and full Yandex Flavored Markdown (YFM) support.
npm i @diplodoc/cli -g
npm run start -- -i ./input-folder -o ./ouput-folder -v "{\"name\":\"Alice\"}"
You need to add .env file into repo root with data below:
GITHUB_OWNER=
GITHUB_REPO= # docs
GITHUB_TOKEN= # personal access token
GITHUB_BASE_URL= # for ex: https://api.github.com
VCS_CONNECTOR_TYPE= # github
or you can update .yfm file into docs repo
connector:
type:
github:
endpoint:
token:
owner:
repo:
cd cli
npm ci && npm run build
MIT
FAQs
Make documentation using yfm-docs in Markdown and HTML formats
The npm package @diplodoc/cli receives a total of 1,180 weekly downloads. As such, @diplodoc/cli popularity was classified as popular.
We found that @diplodoc/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.