Antora

Antora это генератор статических сайтов (SSG). Для оформления текста в нём используется язык разметки AsciiDoc. Как и прочие SSG является ПО работающим в парадигме Docs as code и Единый источник, соответственно.

Пользователи Antora

С использованием Antor реализована документация следующих программных решений:

Fedora Core^[1]

Особенности установки

Доступно без установки в облачной версии Gitlab.

При установке на self-hostet Gitlab для правильно работы первой страницы необходимо выбрать nginx^[2]

Оформление

Включение нумерации заголовков^[3]

Оглавление формируется с помощью символов звездочки, где одна звездочка самый верхний уровень, но можно получить уровень выше звездочки, если воспользоваться такой конструкцией^[5]

.List title 2
* List item
** Nested item

.List title 3
* List item}}

Оглавление в PDF

Оглавление (ТОС) генерируется автоматическ и вставляется в PDF, для активации нужно добавить

toc:

в файл antora-assembler.yml^[6]

Положением ТОС в документе можно управлять с помощью макроса toc::[] ^[7], но это не требуется обычно. По умолчанию Содержание вставляется сразу за обложкой.

Уровни в PDF

Если аттрибут `toclevels` не задан, то он равен `2`. Аттрибут задается в файле antora-assembler.yml

asciidoc:
  attributes:
    toclevels: 3 #количество уровней в автогенеримом ТОС, идущим второй страницей после обложки
    outlinelevels: 1 #outline это букмарки в PDF. Аттрибут управляет количеством уровней в нем.

Ссылки

Официальный сайт Antora

Примечания

[1] ttps://docs.fedoraproject.org/en-US/workstation-docs/

[2] ttps://docs.antora.org/antora/latest/playbook/urls-redirect-facility/

[3] ttps://docs.asciidoctor.org/asciidoc/latest/sections/numbers/

[4] ttps://docs.antora.org/antora/latest/navigation/files-and-lists/

[5] ttps://docs.antora.org/antora/latest/navigation/multiple-lists/

[6] ttps://docs.asciidoctor.org/asciidoc/latest/toc/

[7] ttps://docs.asciidoctor.org/asciidoc/latest/toc/position/

[1]

[2]

[3]

[4]

[5]

[6]

[7]