Полное описание синтаксиса доступно здесь: https://asciidoctor.org/docs/user-manual

Заголовок второго уровня

Полный список здесь: https://asciidoctor.org/docs/user-manual/#style

Заметка.
Предупреждение.
Обратить внимание.
Это важно.

Очень важный блок с предупреждением.

Содержит пункты:

  • Раз.

  • Два.

Список:

  • Пункт 1

  • Пункт 2

Заголовок третьего уровня

Таблица

Пример простой

Service / Component

IntraFind Converter Service

Index and Search Service

Пример с объединением ячеек

Key Description

indexer.context.sharepoint.url

Root URL of SharePoint site.
Sample: https://sp.mycompany.i
Sample Cloud: https://mycompany.sharepoint.com

indexer.context.sharepoint.url.preprocess

JS function for modifying URL before every request

Sample: Requesting SP on different port.

indexer.context.sharepoint.request.url.preprocess:
    new Funct({process : function(url) {
      return url.replace("http://sp.mycompany.i", " https://sp.mycompany.i:555");
   }})

indexer.context.sharepoint.user

SharePoint access user.
Sample: myuser
Sample Cloud: myuser@mycompany.com

Листинги

Конфигурация или иной выделенный фрагмент (source добавляет горизонтальный скроллинг):

# при ошибке правки параметров - обновление таблицы с параметрами, необходимо в случае, если при этом другие параметры изменяются динамическим кодом
onErrorChangeParamsReload=1
# код параметра - категории, который должен быть указан перед переводом процесса в конечный статус
categoryParamId=<param_code>
# требование заполненности параметров перед установкой статуса, одна или несколько записей вида
requireFillParamIdsBeforeStatusSet.<status_to_code>=<param_codes>

Java код:

class My {
   private int a;

   public My() {
                   a = 5;
   }
}

Ссылки

Картинка, всегда в каталоге _res рядом с файлом.

image

Большие картинки можно ограничить по ширине, рекомендовано 600px для горизонтальных изображений и 300 для вертикальных:

image

Класс в системе: ru.bgerp.tool.asciidoc.DocGenerator

Другой документ: Расширение

Другой документ, подраздел в нём: JEXL

Если должна быть внутренняя ссылка, но пока не готов документ, использовать TODO, их можно легко будет найти после. Удобно ставить подобный признак в конце документа, находящегося в стадии написания, это позволяет легко копировать конструкцию в нужное место.

Подобная ссылка вызывает ошибки валидации, удобно ставить в документе, который находится в ходе разработки:

<<todo,todo>>

Выделение

Для любых выделений кроме ссылок использовать полужирный шрифт: переменная путь параметр пункт ⇒ меню ⇒ интерефейса

Схемы

Рекомендуется использовать инструмент: yEd Схемы сохранять в _res каталогах под именами, оканчивающимися на _schema.graphml. Далее экспортировать в этот же каталог в формат PNG с аналогичным именем и вставлять как картинку.

Примеры в данной документации