Skip to content

diplodoc-platform/cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3a0d127 · Oct 25, 2024
Oct 7, 2024
Mar 3, 2022
Jul 11, 2024
Oct 23, 2024
Oct 25, 2024
Oct 25, 2024
Apr 2, 2020
Nov 10, 2022
Dec 28, 2023
Jan 25, 2024
Dec 28, 2023
Oct 24, 2023
Oct 12, 2023
Oct 12, 2023
Jun 8, 2020
Oct 25, 2024
Jun 3, 2020
Jun 3, 2020
Sep 25, 2023
Sep 25, 2023
Oct 25, 2024
Oct 25, 2024
Sep 20, 2024
Apr 15, 2024

Repository files navigation

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