https://github.com/diplodoc-platform/cli

Lets make documentation on YFM
https://github.com/diplodoc-platform/cli

Last synced: 5 days ago
JSON representation

Lets make documentation on YFM

• Host: GitHub
• URL: https://github.com/diplodoc-platform/cli
• Owner: diplodoc-platform
• License: mit
• Created: 2020-04-29T13:20:06.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T18:12:15.000Z (about 1 year ago)
• Last Synced: 2024-10-29T18:55:36.220Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 7.09 MB
• Stars: 115
• Watchers: 22
• Forks: 38
• Open Issues: 48
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

          
**english** | [русский](https://github.com/diplodoc-platform/cli/blob/master/README.ru.md)

- - -

[![NPM version](https://img.shields.io/npm/v/@diplodoc/cli.svg?style=flat)](https://www.npmjs.org/package/@diplodoc/cli)

# yfm-docs

Yfm-docs lets you build a full-fledged documentation project: with navigation, internal transitions, and full

[Yandex Flavored Markdown (YFM)](https://diplodoc.com/docs/en/index-yfm) support.

![Example of displaying a documentation page](.github/assets/overview.jpg)

## Documentation

[ydocs.tech](https://diplodoc.com/docs/en/tools/docs)

## Requirements

Node 22+

## Usage

```bash

npm i @diplodoc/cli -g

```

```bash

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:

```bash

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

```bash

connector:

    type:

    github:

        endpoint:

        token:

        owner:

        repo:

```

### Build from source

```bash

cd cli

npm ci && npm run build

```

## License

MIT