Новая документация Docsvision разворачивается с помощью генератора статических сайтов Antora. Для первой сборки сайта потребуется доступ к репозиториям документации Docsvision, расположенным на GitHub. Репозитории документации обозначены префиксом antora-. Полный список источников указан в файле antora-playbook.yml репозитория antora-playbook.
Документация может быть развёрнута локально, в таком случае адрес документации может быть изменён.
-
Установлен git.
-
Установлен Node.js версии, указанной в разделе "Требования" на сайте документации Antora.
-
Доступ к сайту Github или иной доступ к репозиториям исходного кода документации.
-
Доступ к локальной копии репозитория Docsvision/antora-playbook/.
-
Откройте командную строку с расположением в корне репозитория "Docsvision/antora-playbook/"
-
Установите Antora командой:
npm i
-
Запустите сборку сайта при помощи Antora, выполнив следующую команду:
npx antora antora-playbook.yml
-
Файлы сайта будут расположены в папке
wwwroot.
-
-
Локально — нажмите на сгенерированные html-файлы, расположенные в папке
wwwroot. -
С простого http-сервера — выполните шаги, указанные в инструкции Antora.
-
Поиск по сайту.
-
Просмотр страниц накопительных обновлений.
Чтобы воспользоваться функциями локального (офлайн) поиска, рекомендуется использовать расширение Antora Lunr Search. Подробная инструкция по разворачиванию приведена по ссылке.
При запуске Antora исходные документы будут автоматически получены из репозиториев Docsvision на GitHub (все репозитории с приставкой -Antora).
Если вы хотите изменить исходный код документации, необходимо скопировать содержимое каждого репозитория, указанного в файле antora-playbook.yml:
content:
branches: 'dev'
edit_url: ~
sources:
- url: https://github.com/Docsvision/System-Antora.gitЗамените значение ключа url на собственную ссылку или локальное хранилище. См. подробнее в документации Antora: Repositories and Content Source Roots и URLs for Content Sources, в частности подпункт URLs for Content Sources | Use local content repositories.
Чтобы подробнее разобраться в синтаксисе AsciiDoc, прочитайте материалы на сайте docs.asciidoctor.org.
Также подробнее ознакомьтесь с документацией Antora, чтобы лучше понимать, как создаётся сайт с документацией Docsvision.
Для работы с файлами AsciiDoc рекомендуется использовать ПО Jetbrains IntelliJ Idea с плагином AsciiDoc.