Skip to content

Commit

Permalink
Edit section
Browse files Browse the repository at this point in the history
  • Loading branch information
VitalRu committed Jul 8, 2024
1 parent d866e1d commit a5e224c
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions ru/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,11 @@ input-folder

- output, -o — путь до директории, предназначенной для выходных данных (статических HTML).


#### Пример

```
yfm -i ./input-folder -o ./ouput-folder
```

### Результат

После успешного выполнения работы сборщика появляется или готовый проект HTML или проект в YFM.
Expand All @@ -80,7 +78,8 @@ yfm -i ./input-folder -o ./ouput-folder
В общем случае структура проекта и процедуры построения не отличаются от описанного в предыдущем разделе.
В случае интеграции с вашими СI/CD пайплайнами требуется включение Builder для срабатывания по триггерам обновления документации в репозитории.

Если при коммите в проекты, написанные на С++ или Java пайплайны вызывают определенные компиляторы, то для документации в таком случае роль “компилятор” берет на себя Builder. C его помощью генерируются артефакты, которые могут быть автоматически выложены на внутренние или внешние ресурсы для доступа конечных пользователей.
Как для С++ или Java проектов используются специальные компиляторы в пайплайнах, так для документации эта задача выполняется Builder'ом. Он создает готовые документы (артефакты), которые потом можно автоматически разместить на внутренних или внешних ресурсах для пользователей.


### Подключение плагинов и расширенная конфигурация

Expand All @@ -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.
Expand Down

0 comments on commit a5e224c

Please sign in to comment.