Fork me on GitHub
asciidoctor small
More

This is a nice HTML handbook. You should also try out:

1. Attributes

Demo the usage of attributes.

1.1. Environment attributes

  • backend: html5

  • asciidoctor-version: 2.0.8

1.2. Custom attributes

Variables can be passed as custom attributes, initialized from a maven property (no maven filtering of .adoc files needed)

<attributes>
  <awesome-version>${awesome.version}</awesome-version>
</attributes>

Awesome library version: 1.3.

2. Admonitions

Demo the display of icons as images or fonts.

Note
Warning
Tip
Important
Caution

3. Source code

Demo source code inclusion.

3.1. Inline source

public class HelloWorld { (1)
  public static void main(String[] args) { (2)
    // Prints "Hello, World" to the terminal window. Here is some very large comment that should cause an overflow
    System.out.println("Hello, World");
  }
}
1 The class name
2 The main method

3.2. Referenced source

public static void main(String[] args) { (1)
  System.out.println("Hello, World");
}
1 The main method
Also see the Javadoc.

4. Diagrams

Demo the inclusion of semantic diagrams.

4.1. Graphviz

dot example

❶ From a to b

❷ From b to c

4.2. Plantuml

plantuml example

❶ Uses SSL

5. Sub-document

Demo the inclusion of sub-documents, with relative paths for images/icons/diagrams.

Demo linking across sections and documents.

6.1. Internal cross references

Also refer to these other sections:

Glossary elements like something.

6.2. Inter-document cross references

Also refer to these documents:

Index