@diplodoc/cli

4.34.2 • Public • Published

english | русский


NPM version

yfm-docs

Yfm-docs lets you build a full-fledged documentation project: with navigation, internal transitions, and full Yandex Flavored Markdown (YFM) support.

Example of displaying a documentation page

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= # 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:

Build from source

cd cli
npm ci && npm run build

License

MIT

Package Sidebar

Install

npm i @diplodoc/cli

Weekly Downloads

709

Version

4.34.2

License

MIT

Unpacked Size

45.8 MB

Total Files

111

Last publish

Collaborators

  • makhnatkin
  • yndx-birman111
  • martyanov-av
  • vsesh
  • rndnm
  • v8tenko
  • moki
  • 3y3
  • alexey_w100
  • robot-dataui-npm