AsciiDoc

Diagrams

PUML and other diagrams

08-11-2023, source: GitHub: asciidoctor-kroki

  1. Install the extension:

    yarn add asciidoctor-kroki

  2. Enable the extension in antora-playbook.yml. Beware, it is asciidoc extension, not antora extension, just add another key:

    antora:
  extensions:
    ...
asciidoc:
  extensions:
    asciidoctor-kroki

Now, there are two choices:

  1. Refer to a partial with the puml file extension:

     [plantuml,target=ab-partial-1,format=svg]
 ----
 include::partial$puml/alice-bob.puml[]
 ----

  2. Write down the puml code and render it directly:

     [plantuml,ab-partial-all-1,svg]
 ----
 alice -> bob
 bob -> alice
 ----

Escaping

Triple plus passthrough

02-22-2026, source: AsciiDoctor

The triple-plus passthrough works much the same way as the pass macro. To exclude content from substitutions, enclose it in triple pluses (+++).

In AsciiDoc, {text} is the syntax for Attributes (variables). When Antora sees {header}, it tries to find a variable named header.

{text} refers to a variable
`{text}` refers to a variable formatted as a code
`+++{text}+++` displays the braces and text as is