New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More

@diplodoc/cli

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@diplodoc/cli

Make documentation using yfm-docs in Markdown and HTML formats

5.0.0-alpha-3
Version published
Maintainers
10
Created

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

FAQs

Package last updated on 31 Jan 2025

Did you know?

Socket

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.

Install

Related posts