From 1ad46d7e540a972509ba7af6655d047a724257cf Mon Sep 17 00:00:00 2001 From: Rudenko Vitaliy Date: Sun, 30 Jun 2024 20:40:07 +0700 Subject: [PATCH 01/10] Draft pt1 --- ru/how-it-work.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/ru/how-it-work.md b/ru/how-it-work.md index e5d866a..be78754 100644 --- a/ru/how-it-work.md +++ b/ru/how-it-work.md @@ -1,7 +1,35 @@ # Основные сценарии использования Diplodoc -## Создание простого документационного проекта в YFM +## Быстрый старт + +{% note info %} + +Для работы с Diplodoc вам потребуются учетная запись на [GitHub](https://github.com/) и система контроля версий [Git](https://git-scm.com/downloads). + +{% endnote %} + + + +Перейдите на сайт [diplodoc.com][https://diplodoc.com/] и нажмите кнопку **Начать**. + +Следуйте инструкции, указанной на странице. + +В результате на вашей странице GitHub будет автоматически создан репозиторий `diplodoc-example` и создана ссылка на пример документации. + +### Редактирование документа + +1. Склонируйте репозиторий; + +1. Cоздайте новую ветку и внесите изменения в файлы папки `docs`; + +1. Сделайте пул-реквест. + + Будет запущен экшн `build-docs`, который создаст превью вашего документа. (А где его посмотреть, пока что открытый вопрос.) + + + +## Создание простого документационного проекта в YFM ### Структура проекта Базовый проект состоит из нескольких конфигурационных файлов и страниц с контентом, связанных между собой в следующую структуру: From 207d6279008bfa32346c37a5492fd09eb7760527 Mon Sep 17 00:00:00 2001 From: Rudenko Vitaliy Date: Sun, 30 Jun 2024 20:58:35 +0700 Subject: [PATCH 02/10] Add line --- ru/how-it-work.md | 1 + 1 file changed, 1 insertion(+) diff --git a/ru/how-it-work.md b/ru/how-it-work.md index be78754..b45b4f4 100644 --- a/ru/how-it-work.md +++ b/ru/how-it-work.md @@ -27,6 +27,7 @@ Будет запущен экшн `build-docs`, который создаст превью вашего документа. (А где его посмотреть, пока что открытый вопрос.) +После слияния вашей ветки с веткой `main`, пересоберите ваш документ. Для этого перейдите на вкладку **actions**, выберите экшн **release** и в левом верхнем углу нажмите кнопку **Re-run all jobs**. ## Создание простого документационного проекта в YFM From b05f7a5aa26f6de72849dfd9a2d2873eacd22422 Mon Sep 17 00:00:00 2001 From: Rudenko Vitaliy Date: Mon, 1 Jul 2024 09:45:30 +0700 Subject: [PATCH 03/10] Add GitHub Pages section --- ru/how-it-work.md | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/ru/how-it-work.md b/ru/how-it-work.md index b45b4f4..f697535 100644 --- a/ru/how-it-work.md +++ b/ru/how-it-work.md @@ -25,10 +25,44 @@ 1. Сделайте пул-реквест. - Будет запущен экшн `build-docs`, который создаст превью вашего документа. (А где его посмотреть, пока что открытый вопрос.) + Сработает экшн `build-docs`, который создаст превью вашего документа. (А где его посмотреть, пока что открытый вопрос.) -После слияния вашей ветки с веткой `main`, пересоберите ваш документ. Для этого перейдите на вкладку **actions**, выберите экшн **release** и в левом верхнем углу нажмите кнопку **Re-run all jobs**. +После слияния вашей ветки с веткой `main`, пересоберите ваш документ. Для этого перейдите на вкладку **actions**, выберите экшн **release** и в верхнем правом углу нажмите кнопку **Re-run all jobs**. +Этот раздел требует уточнения. Документ должен быть доступен по ссылке `<имя_пользователя_на_гитхабе>--viewer.diplodoc.com/en/`>, но такая ссылка не работает. + +### Размещение документа на GitHub Pages + +**Видеоинструкция** + +@[YouTube](https://youtu.be/6j4egX9eY9I?t=7123) + +1. В GitHub в репозитории вашего документа перейдите на вкладку **Settings** и в меню слева выберите **Pages**. + +1. В разделе **Build and deployment** в выпадающем списке выберите **GitHub Actions** и в появившемся блоке **Static HTML** нажмите кнопку **Configure**. Откроется окно редактирования экшна. + +1. В блоке `jobs` после строки `uses: actions/configure-pages@v5` добавьте код + + ```yaml + - name: Build docs + uses: diplodoc-platform/docs-build-action@v3 + with: + src-root: './docs' + build-root: './docs-html' + ``` + + +{% note info %} + +В представленной выше [видеоинтрукции](https://youtu.be/6j4egX9eY9I?t=7123) для параметра `build-docs` указано значение `'./build'`. При такой настройке ссылка из п.5 будет выдавать ошибку 404. + +{% endnote %} + + + +1. Вверху справа нажмите **Commit changes**, укажите имя коммита в поле **Commit Changes** нажмите кнопку **Commit changes**. + +1. Перейдите на вкладку **Actions**. После завершения сборки, документ будет размещен на GitHub Pages. Посмотреть его можно по ссылке ниже под надписью **deploy**. ## Создание простого документационного проекта в YFM From 089508ba4752fb2faf88070d62b10a31a7b2a634 Mon Sep 17 00:00:00 2001 From: Rudenko Vitaliy Date: Wed, 3 Jul 2024 10:56:44 +0700 Subject: [PATCH 04/10] Draft --- ru/how-it-work.md | 43 ++++++++++++++++++++++++++----------------- 1 file changed, 26 insertions(+), 17 deletions(-) diff --git a/ru/how-it-work.md b/ru/how-it-work.md index f697535..fadc772 100644 --- a/ru/how-it-work.md +++ b/ru/how-it-work.md @@ -3,19 +3,29 @@ ## Быстрый старт -{% note info %} + +{% note warning %} Для работы с Diplodoc вам потребуются учетная запись на [GitHub](https://github.com/) и система контроля версий [Git](https://git-scm.com/downloads). {% endnote %} +1. Перейдите на сайт [diplodoc.com](https://diplodoc.com/) и нажмите кнопку **Начать**. + +2. Следуйте инструкции, указанной на странице. + + + + На вашей странице GitHub будет автоматически создан репозиторий `diplodoc-example` и создана ссылка на пример документации. + + +{% note info %} -Перейдите на сайт [diplodoc.com][https://diplodoc.com/] и нажмите кнопку **Начать**. +Чтобы изменить стандартное имя репозитория `diplodoc-example`, [свяжитесь с нами](https://diplodoc.com/#contact). -Следуйте инструкции, указанной на странице. +{% endnote %} -В результате на вашей странице GitHub будет автоматически создан репозиторий `diplodoc-example` и создана ссылка на пример документации. ### Редактирование документа @@ -25,11 +35,13 @@ 1. Сделайте пул-реквест. - Сработает экшн `build-docs`, который создаст превью вашего документа. (А где его посмотреть, пока что открытый вопрос.) + Сработает экшн `build-docs`, который создаст превью вашего документа. + + После слияния вашей ветки с веткой `main`, пересоберите ваш документ. Для этого перейдите на вкладку **actions**, выберите экшн **release** и в верхнем правом углу нажмите кнопку **Re-run all jobs**. -Этот раздел требует уточнения. Документ должен быть доступен по ссылке `<имя_пользователя_на_гитхабе>--viewer.diplodoc.com/en/`>, но такая ссылка не работает. + ### Размещение документа на GitHub Pages @@ -54,15 +66,16 @@ {% note info %} -В представленной выше [видеоинтрукции](https://youtu.be/6j4egX9eY9I?t=7123) для параметра `build-docs` указано значение `'./build'`. При такой настройке ссылка из п.5 будет выдавать ошибку 404. +В представленной выше [видеоинструкции](https://youtu.be/6j4egX9eY9I?t=7123) для параметра `build-root` указано значение `'./build'`. При такой настройке ссылка из п.5 будет выдавать ошибку 404. {% endnote %} +1. Вверху справа нажмите **Commit changes...**, укажите имя коммита в поле **Commit message** и нажмите кнопку **Commit changes**. -1. Вверху справа нажмите **Commit changes**, укажите имя коммита в поле **Commit Changes** нажмите кнопку **Commit changes**. +1. Перейдите на вкладку **Actions**. Вверху списка будет ваш последний коммит. -1. Перейдите на вкладку **Actions**. После завершения сборки, документ будет размещен на GitHub Pages. Посмотреть его можно по ссылке ниже под надписью **deploy**. +1. Нажмите на название коммита. После завершения сборки, документ будет размещен на GitHub Pages. Посмотреть его можно по ссылке ниже под надписью **deploy**. ## Создание простого документационного проекта в YFM @@ -86,15 +99,11 @@ input-folder |-- faq_shared_block.md ``` - -Больше информации про параметры и конфигурацию можно найти по [ссылке](./project/index.md). - - +Больше информации про параметры и конфигурацию можно найти в разделе [**Документационный проект**](./project/index.md). ### Сборка проекта -Сборка выполняется с помощью инструмента Builder в командной строке. - +Сборка выполняется с помощью инструмента [**Builder**](tools/docs/index.md) в командной строке. Чтобы запустить сборку, выполните команду, указав обязательные ключи запуска @@ -112,7 +121,7 @@ yfm -i ./input-folder -o ./ouput-folder ### Результат -После успешного выполнения работы сборщика появляется или готовый проект HTML или проект в YFM. +После успешного выполнения работы сборщика появляется или готовый проект HTML или проект в YFM. Часто вывод в YFM применяется для создания подразделов и включения в крупные проекты. @@ -146,4 +155,4 @@ yfm -i ./input-folder -o ./ouput-folder Если Ваш проект использует Github как систему контроля версий и место хранения исходного кода Вашей документации, Diplodoc позволит создать полностью интегрированный пайплайн работы, покрывающий все шаги от внесения изменений в исходные тексты до построения проекта с помощью Github actions и интеграции с Elastic Search. -[Свяжитесь с нами](https://diplodoc.com/#contact), чтобы обсудить детали Вашей конфигурации и возможные варианты решения. +[Свяжитесь с нами](https://diplodoc.com/#contact), чтобы обсудить детали Вашей конфигурации и возможные варианты решения. From 4b4d807c310788c6835cde35fbb56933cad9588f Mon Sep 17 00:00:00 2001 From: Rudenko Vitaliy Date: Wed, 3 Jul 2024 11:07:38 +0700 Subject: [PATCH 05/10] Hide video to cut --- ru/how-it-work.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/ru/how-it-work.md b/ru/how-it-work.md index fadc772..a3e3ec2 100644 --- a/ru/how-it-work.md +++ b/ru/how-it-work.md @@ -45,10 +45,13 @@ ### Размещение документа на GitHub Pages -**Видеоинструкция** +{% cut "Видеоинструкция" %} @[YouTube](https://youtu.be/6j4egX9eY9I?t=7123) +{% endcut %} + + 1. В GitHub в репозитории вашего документа перейдите на вкладку **Settings** и в меню слева выберите **Pages**. 1. В разделе **Build and deployment** в выпадающем списке выберите **GitHub Actions** и в появившемся блоке **Static HTML** нажмите кнопку **Configure**. Откроется окно редактирования экшна. From a4c38ff172142544f362f56dd1307eea3a7ea119 Mon Sep 17 00:00:00 2001 From: Rudenko Vitaliy Date: Mon, 8 Jul 2024 11:17:31 +0700 Subject: [PATCH 06/10] Edits --- ru/{how-it-work.md => quickstart.md} | 123 ++++++++++----------------- ru/toc.yaml | 4 +- 2 files changed, 45 insertions(+), 82 deletions(-) rename ru/{how-it-work.md => quickstart.md} (64%) diff --git a/ru/how-it-work.md b/ru/quickstart.md similarity index 64% rename from ru/how-it-work.md rename to ru/quickstart.md index a3e3ec2..34a7e96 100644 --- a/ru/how-it-work.md +++ b/ru/quickstart.md @@ -1,8 +1,5 @@ -# Основные сценарии использования Diplodoc - -## Быстрый старт - +# Быстрый старт {% note warning %} @@ -13,12 +10,9 @@ 1. Перейдите на сайт [diplodoc.com](https://diplodoc.com/) и нажмите кнопку **Начать**. -2. Следуйте инструкции, указанной на странице. - - - - На вашей странице GitHub будет автоматически создан репозиторий `diplodoc-example` и создана ссылка на пример документации. +1. Следуйте инструкции, указанной на странице. +1. На вашей странице GitHub будет автоматически создан репозиторий `diplodoc-example` и создана ссылка на пример документации. {% note info %} @@ -26,63 +20,10 @@ {% endnote %} - -### Редактирование документа - -1. Склонируйте репозиторий; - -1. Cоздайте новую ветку и внесите изменения в файлы папки `docs`; - -1. Сделайте пул-реквест. - - Сработает экшн `build-docs`, который создаст превью вашего документа. - - - -После слияния вашей ветки с веткой `main`, пересоберите ваш документ. Для этого перейдите на вкладку **actions**, выберите экшн **release** и в верхнем правом углу нажмите кнопку **Re-run all jobs**. - - - -### Размещение документа на GitHub Pages - -{% cut "Видеоинструкция" %} - -@[YouTube](https://youtu.be/6j4egX9eY9I?t=7123) - -{% endcut %} - - -1. В GitHub в репозитории вашего документа перейдите на вкладку **Settings** и в меню слева выберите **Pages**. - -1. В разделе **Build and deployment** в выпадающем списке выберите **GitHub Actions** и в появившемся блоке **Static HTML** нажмите кнопку **Configure**. Откроется окно редактирования экшна. - -1. В блоке `jobs` после строки `uses: actions/configure-pages@v5` добавьте код - - ```yaml - - name: Build docs - uses: diplodoc-platform/docs-build-action@v3 - with: - src-root: './docs' - build-root: './docs-html' - ``` - - -{% note info %} - -В представленной выше [видеоинструкции](https://youtu.be/6j4egX9eY9I?t=7123) для параметра `build-root` указано значение `'./build'`. При такой настройке ссылка из п.5 будет выдавать ошибку 404. - -{% endnote %} - - -1. Вверху справа нажмите **Commit changes...**, укажите имя коммита в поле **Commit message** и нажмите кнопку **Commit changes**. - -1. Перейдите на вкладку **Actions**. Вверху списка будет ваш последний коммит. - -1. Нажмите на название коммита. После завершения сборки, документ будет размещен на GitHub Pages. Посмотреть его можно по ссылке ниже под надписью **deploy**. - ## Создание простого документационного проекта в YFM ### Структура проекта + Базовый проект состоит из нескольких конфигурационных файлов и страниц с контентом, связанных между собой в следующую структуру: @@ -108,7 +49,7 @@ input-folder Сборка выполняется с помощью инструмента [**Builder**](tools/docs/index.md) в командной строке. -Чтобы запустить сборку, выполните команду, указав обязательные ключи запуска +Чтобы запустить сборку, выполните команду, указав обязательные ключи запуска: - input, -i — путь до директории проекта. @@ -118,44 +59,66 @@ input-folder #### Пример + ``` yfm -i ./input-folder -o ./ouput-folder ``` - ### Результат + После успешного выполнения работы сборщика появляется или готовый проект HTML или проект в YFM. Часто вывод в YFM применяется для создания подразделов и включения в крупные проекты. +### Использование - -### Использование Готовые проекты в HTML можно использовать локально или разместить на подходящем для Вас хостинге, включая S3-like хранилище. +## Интеграция в ваш процесс разработки - -## Интеграция в Ваш процесс разработки ### Создание и построение проекта -В общем случае структура проекта и процедуры построения не отличаются от описанного в предыдущей секции. -Однако в случае интеграции с Вашими СI/CD пайплайнами требуется включение Builder для срабатывания по триггерам обновления документации в репозитории. +В общем случае структура проекта и процедуры построения не отличаются от описанного в предыдущем разделе. +В случае интеграции с вашими СI/CD пайплайнами требуется включение Builder для срабатывания по триггерам обновления документации в репозитории. -Если при коммите в проекты, написанные на С++ или Java пайплайны вызывают определенные компиляторы, то для документации в таком случае -роль “компилятор” берет на себя Builder. C его помощью генерируются артефакты, которые могут быть автоматически выложены на -внутренние или внешние ресурсы для доступа конечных пользователей. +Если при коммите в проекты, написанные на С++ или Java пайплайны вызывают определенные компиляторы, то для документации в таком случае роль “компилятор” берет на себя Builder. C его помощью генерируются артефакты, которые могут быть автоматически выложены на внутренние или внешние ресурсы для доступа конечных пользователей. ### Подключение плагинов и расширенная конфигурация -Как правило, большие документационные проекты используют дополнительные возможности по работе с контентом и специфичные конфигурации для построения. -Примером таких расширений является возможность работы с видео или многострочных таблиц. + +Как правило, большие документационные проекты используют дополнительные возможности по работе с контентом и специфичные конфигурации для построения. +Примером таких расширений является возможность работы с видео или многострочными таблицами. + Подробнее о способах корректного отображения и трансформации контента можно почитать на [странице](./plugins/index.md). -Особенностью конфигурации при построении может быть возможность отключения линтера или сборка проекта в виде одного большого html файла. -Дополнительно о таких возможностях можно ознакомиться на [странице](./tools/transform/settings.md). +Особенностью конфигурации при построении может быть возможность отключения линтера или сборка проекта в виде одного большого HTML-файла. + +Дополнительно с такими возможностями можно ознакомиться на [странице](./tools/transform/settings.md). ## Работа с Github и публикация документов на своем домене или домене https://diplodoc.com -Если Ваш проект использует Github как систему контроля версий и место хранения исходного кода Вашей документации, Diplodoc позволит создать полностью интегрированный пайплайн работы, покрывающий все шаги от внесения изменений в исходные тексты до построения проекта с помощью Github actions и интеграции с Elastic Search. +Если ваш проект использует Github как систему контроля версий и место хранения исходного кода вашей документации, Diplodoc позволит создать полностью интегрированный пайплайн работы, покрывающий все шаги от внесения изменений в исходные тексты до построения проекта с помощью Github actions и интеграции с Elastic Search. + +[Свяжитесь с нами](https://diplodoc.com/#contact), чтобы обсудить детали вашей конфигурации и возможные варианты решения. + +### Размещение документа на GitHub Pages + +1. В GitHub в репозитории вашего документа перейдите на вкладку **Settings** и в меню слева выберите **Pages**. + +1. В разделе **Build and deployment** в выпадающем списке выберите **GitHub Actions** и в появившемся блоке **Static HTML** нажмите кнопку **Configure**. Откроется окно редактирования экшна. + +1. В блоке `jobs` после строки `uses: actions/configure-pages@v5` добавьте код -[Свяжитесь с нами](https://diplodoc.com/#contact), чтобы обсудить детали Вашей конфигурации и возможные варианты решения. + ```yaml + - name: Build docs + uses: diplodoc-platform/docs-build-action@v3 + with: + src-root: './docs' + build-root: './docs-html' + ``` + +1. Вверху справа нажмите **Commit changes...**, укажите имя коммита в поле **Commit message** и нажмите кнопку **Commit changes**. + +1. Перейдите на вкладку **Actions**. Вверху списка будет ваш последний коммит. + +1. Нажмите на название коммита. После завершения сборки, документ будет размещен на GitHub Pages. Посмотреть его можно по ссылке ниже под надписью **deploy**. diff --git a/ru/toc.yaml b/ru/toc.yaml index a5bef10..100ab4b 100644 --- a/ru/toc.yaml +++ b/ru/toc.yaml @@ -31,8 +31,8 @@ navigation: items: - name: Обзор системы href: about.md - - name: Начало работы - href: how-it-work.md + - name: Быстрый старт + href: quickstart.md - name: Yandex Flavored Markdown expanded: true href: index-yfm.md From 0038a099e17dfc01d11c227c19864bc78cde1a71 Mon Sep 17 00:00:00 2001 From: Rudenko Vitaliy Date: Mon, 8 Jul 2024 11:19:44 +0700 Subject: [PATCH 07/10] Restore file name --- ru/{quickstart.md => how-it-work.md} | 0 ru/toc.yaml | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename ru/{quickstart.md => how-it-work.md} (100%) diff --git a/ru/quickstart.md b/ru/how-it-work.md similarity index 100% rename from ru/quickstart.md rename to ru/how-it-work.md diff --git a/ru/toc.yaml b/ru/toc.yaml index 100ab4b..3eab2a4 100644 --- a/ru/toc.yaml +++ b/ru/toc.yaml @@ -32,7 +32,7 @@ items: - name: Обзор системы href: about.md - name: Быстрый старт - href: quickstart.md + href: how-it-work.md - name: Yandex Flavored Markdown expanded: true href: index-yfm.md From 9a864d7248fe19f9ed1f31e626bee615445417a0 Mon Sep 17 00:00:00 2001 From: Rudenko Vitaliy Date: Mon, 8 Jul 2024 11:26:23 +0700 Subject: [PATCH 08/10] Rename again --- ru/{how-it-work.md => quickstart.md} | 0 ru/toc.yaml | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename ru/{how-it-work.md => quickstart.md} (100%) diff --git a/ru/how-it-work.md b/ru/quickstart.md similarity index 100% rename from ru/how-it-work.md rename to ru/quickstart.md diff --git a/ru/toc.yaml b/ru/toc.yaml index 3eab2a4..100ab4b 100644 --- a/ru/toc.yaml +++ b/ru/toc.yaml @@ -32,7 +32,7 @@ items: - name: Обзор системы href: about.md - name: Быстрый старт - href: how-it-work.md + href: quickstart.md - name: Yandex Flavored Markdown expanded: true href: index-yfm.md From d866e1da6e1fd15d25e0777ab1cb5255ac6e80bd Mon Sep 17 00:00:00 2001 From: Rudenko Vitaliy Date: Mon, 8 Jul 2024 11:29:16 +0700 Subject: [PATCH 09/10] Edit index.yaml --- ru/index.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ru/index.yaml b/ru/index.yaml index 140f8ac..8307a54 100644 --- a/ru/index.yaml +++ b/ru/index.yaml @@ -7,9 +7,9 @@ links: - title: Обзор системы description: Описание платформы, ее основные возможности, особенности и преимущества. href: about.md -- title: Как попробовать +- title: Быстрый старт description: С чего начать работу - href: how-it-work.md + href: quickstart.md - title: Yandex Flavored Markdown description: Описание языка Yandex Flavored Markdown. href: index-yfm.md From a5e224c37a5cd9e12a66081fff326fa8ff52a595 Mon Sep 17 00:00:00 2001 From: Rudenko Vitaliy Date: Mon, 8 Jul 2024 12:09:16 +0700 Subject: [PATCH 10/10] Edit section --- ru/quickstart.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/ru/quickstart.md b/ru/quickstart.md index 34a7e96..05206f6 100644 --- a/ru/quickstart.md +++ b/ru/quickstart.md @@ -57,13 +57,11 @@ input-folder - output, -o — путь до директории, предназначенной для выходных данных (статических HTML). - #### Пример ``` yfm -i ./input-folder -o ./ouput-folder ``` - ### Результат После успешного выполнения работы сборщика появляется или готовый проект HTML или проект в YFM. @@ -80,7 +78,8 @@ yfm -i ./input-folder -o ./ouput-folder В общем случае структура проекта и процедуры построения не отличаются от описанного в предыдущем разделе. В случае интеграции с вашими СI/CD пайплайнами требуется включение Builder для срабатывания по триггерам обновления документации в репозитории. -Если при коммите в проекты, написанные на С++ или Java пайплайны вызывают определенные компиляторы, то для документации в таком случае роль “компилятор” берет на себя Builder. C его помощью генерируются артефакты, которые могут быть автоматически выложены на внутренние или внешние ресурсы для доступа конечных пользователей. +Как для С++ или Java проектов используются специальные компиляторы в пайплайнах, так для документации эта задача выполняется Builder'ом. Он создает готовые документы (артефакты), которые потом можно автоматически разместить на внутренних или внешних ресурсах для пользователей. + ### Подключение плагинов и расширенная конфигурация @@ -93,8 +92,6 @@ yfm -i ./input-folder -o ./ouput-folder Дополнительно с такими возможностями можно ознакомиться на [странице](./tools/transform/settings.md). - - ## Работа с Github и публикация документов на своем домене или домене https://diplodoc.com Если ваш проект использует Github как систему контроля версий и место хранения исходного кода вашей документации, Diplodoc позволит создать полностью интегрированный пайплайн работы, покрывающий все шаги от внесения изменений в исходные тексты до построения проекта с помощью Github actions и интеграции с Elastic Search.