diff --git a/README.md b/README.md index 88cd4681..44bb0632 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/README.ru.md b/README.ru.md index f0332863..d1e74587 100644 --- a/README.ru.md +++ b/README.ru.md @@ -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 @@ -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 diff --git a/package-lock.json b/package-lock.json index b3001f0d..b86844e6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "@doc-tools/docs", + "name": "@diplodoc/docs", "version": "3.25.0", "lockfileVersion": 1, "requires": true, diff --git a/package.json b/package.json index e144c6ab..132e963f 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,12 @@ { - "name": "@doc-tools/docs", + "name": "@diplodoc/docs", "author": "Yandex Data UI Team ", "description": "Make documentation using yfm-docs in Markdown and HTML formats", "license": "MIT", "version": "3.25.0", "repository": { "type": "git", - "url": "git@github.com:yandex-cloud/yfm-docs.git" + "url": "git@github.com:diplodoc-platform/cli.git" }, "bin": { "yfm": "build/index.js"