Skip to content

Commit

Permalink
feat!: move to diplodoc
Browse files Browse the repository at this point in the history
  • Loading branch information
v8tenko committed Sep 25, 2023
1 parent 808a3e2 commit d0a0ad0
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 29 deletions.
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
**english** | [русский](https://github.com/yandex-cloud/yfm-docs/blob/master/README.ru.md)
**english** | [русский](https://github.com/diplodoc-platform/cli/blob/master/README.ru.md)
- - -

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

# yfm-docs

Yfm-docs lets you build a full-fledged documentation project: with navigation, internal transitions, and full
[Yandex Flavored Markdown (YFM)](https://ydocs.tech) support.
[Yandex Flavored Markdown (YFM)](https://diplodoc.com/docs/ru/index-yfm) support.

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

## Documentation

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

## Usage

```bash
npm i @doc-tools/docs -g
npm i @diplodoc/docs -g
```

```bash
Expand Down Expand Up @@ -53,17 +53,10 @@ connector:
### Build from source

```bash
cd yfm-docs
cd cli
npm ci && npm run build
```

### Run TS directly for debug in IDE

```bash
npm run start-ts
```


## License

MIT
19 changes: 6 additions & 13 deletions README.ru.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
**русский** | [english](https://github.com/yandex-cloud/yfm-docs/blob/master/README.md)
**русский** | [english](https://github.com/diplodoc-platform/cli/blob/master/README.md)
- - -

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

# yfm-docs

Yfm-docs позволяет собрать полноценный документационный проект: с навигацией, внутренними переходами и полной поддержкой
[Yandex Flavored Markdown (YFM)](https://ydocs.tech).
[Yandex Flavored Markdown (YFM)](https://diplodoc.com/docs/ru/index-yfm).

![Пример отображения страницы документации](docsAssets/overview.jpg)

## Документация

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

## Использование

```bash
npm i @doc-tools/docs -g
npm i @diplodoc/docs -g
```

```bash
Expand Down Expand Up @@ -54,17 +54,10 @@ connector:
### Сборка из исходников

```bash
cd yfm-docs
cd cli
npm ci && npm run build
```

### Запуск TS-кода напрямую для возможности его подебажить в IDE

```bash
npm run start-ts
```


## License

MIT
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "@doc-tools/docs",
"name": "@diplodoc/docs",
"author": "Yandex Data UI Team <[email protected]>",
"description": "Make documentation using yfm-docs in Markdown and HTML formats",
"license": "MIT",
"version": "3.25.0",
"repository": {
"type": "git",
"url": "[email protected]:yandex-cloud/yfm-docs.git"
"url": "[email protected]:diplodoc-platform/cli.git"
},
"bin": {
"yfm": "build/index.js"
Expand Down

0 comments on commit d0a0ad0

Please sign in to comment.