Новая документация Docsvision разворачивается с помощью генератора статических сайтов Antora.

Для первой сборки сайта потребуется подключение к интернету, в будущем интернет-соединение потребуется только для получения последних изменений в документации.

1. Перейдите по ссылке, скачайте и установите git.

2. Установите Node.js предпочтительным способом или скачайте инсталлятор с официального сайта.

3. Скопируйте на компьютер данный (Docsvision/antora-playbook) репозиторий.

   • Выполните в Powershell:

     git clone https://github.com/Grolribasi/antora-playbook.git

4. Перейдите в каталог репозитория:

   cd antora-playbook

5. Установите Antora командой:

   npm i

6. Откройте файл /antora-playbook/antora-playbook.yml и при необходимости отредактируйте URL сайта:

   site:
     title: Документация Docsvision
     url: https://help.docsvision.com/ (1)
     robots: allow

   1. Укажите адрес сервера, на котором будет развёрнута документация.

7. Запустите сборку сайта при помощи Antora, выполнив следующую команду в окне Powershell:

   npx antora antora-playbook.yml

   Если планируется просматривать html-файлы локально, без запуска сервера, удалите следующую строку в antora-playbook.yml:

   html_extension_style: indexify

   Тогда после сборки путь к HTML-файлам будет короче.

8. Файлы сайта будут расположены в папке wwwroot.

• Локально — нажмите на сгенерированные html-файлы.

• С простого http-сервера — выполните шаги ниже.

1. Перейдите в папку репозитория antora-playbook.

2. Установите локальный http-сервер следующей командой:

   antora-playbook $ npm i -g http-server

3. Выполните команду http-server, например, так:

   antora-playbook\wwwroot $ http-server build/site -c-1 -p 5000

4. После запуска команды, локальный адрес веб-сервера будет отображён в окне консоли следующим образом:

   Starting up http-server, serving antora-playbook\wwwroot
   Available on:
     http://127.0.0.1:5000
     http://192.168.1.8:5000
   Hit CTRL-C to stop the server

5. Вставьте любой адрес из списка в строку браузера, что просмотреть сайт через локальный веб-сервер.

В собранном сайте не будет работать поиск.

При запуске Antora исходные документы будут автоматически получены из репозиториев Docsvision на GitHub (все репозитории с приставкой -Antora).

Если вы хотите изменить исходный код документации, необходимо скопировать содержимое каждого репозитория, указанного в файле antora-playbook.yml:

Замените значение ключа url на собственную ссылку или локальное хранилище. См. подробнее в документации Antora: Repositories and Content Source Roots и URLs for Content Sources, в частности подпункт URLs for Content Sources | Use local content repositories.

Для работы с файлами AsciiDoc рекомендуется использовать ПО Jetbrains IntelliJ Idea с плагином AsciiDoc.