Antora & AsciiDoc Feature Reference
Comprehensive reference of Antora and AsciiDoc features. Legend: ✓ = Currently Using | ○ = Available (Not Using) | ✗ = Not Applicable
Antora Component Features
| Status | Feature | Purpose | Current Usage |
|---|---|---|---|
✓ |
|
Component identifier for xrefs |
|
✓ |
|
Display name in UI |
|
✓ |
|
Version identifier (~=versionless) |
|
✓ |
|
Friendly name in version selector |
|
✓ |
|
Landing page for component |
|
✓ |
|
Navigation file references |
|
○ |
|
Mark version as prerelease |
Not using - stable content |
○ |
|
Load Asciidoctor extensions |
Available for custom extensions |
Page-Level Features
| Status | Feature | Purpose | How to Use |
|---|---|---|---|
✓ |
|
URL redirects for moved pages |
|
○ |
|
Include page as partial elsewhere |
|
○ |
|
Component-specific page attributes |
|
✓ |
|
Sidebar TOC depth |
Set to |
AsciiDoc Document Attributes
Core Features (Currently Enabled)
| Status | Attribute | Purpose | Current Value |
|---|---|---|---|
✓ |
|
Enable icon rendering |
|
✓ |
|
Enable ]+btn:[, menu:[] |
Enabled (empty string) |
✓ |
|
Syntax highlighting engine |
|
✓ |
|
Cross-reference display format |
|
✓ |
|
Clickable ¶ anchors on headings |
Enabled |
✓ |
|
Make headings clickable links |
Enabled |
✓ |
|
Hide https:// in displayed URLs |
Enabled |
✓ |
|
Document language (accessibility) |
|
✓ |
|
Handle undefined attributes |
|
✓ |
|
SEO metadata |
|
Available But Not Using
| Status | Attribute | Purpose | How to Enable |
|---|---|---|---|
○ |
|
Enable math/science notation |
|
○ |
|
Automatic equation numbering |
|
○ |
|
Automatic section numbering |
|
○ |
|
Depth of section numbering |
|
○ |
|
In-document TOC (Antora handles) |
|
○ |
|
In-document TOC depth |
|
○ |
|
Omit last-modified timestamps |
|
○ |
|
Show document title as heading |
|
○ |
|
Suppress footer output |
|
○ |
|
Number parts (book doctype) |
|
Custom Admonitions (Currently Using)
| Type | Current Caption | Example |
|---|---|---|
TIP |
💡 Tip |
TIP: This is a tip |
NOTE |
📝 Note |
NOTE: This is a note |
WARNING |
⚠️ Warning |
WARNING: This is a warning |
CAUTION |
🔥 Caution |
CAUTION: Proceed carefully |
IMPORTANT |
❗ Important |
IMPORTANT: Don’t miss this |
Usage Examples
TIP: Use `subs=attributes+` for code blocks with attributes.
[NOTE]
====
This is a block admonition.
It can contain multiple paragraphs.
====
UI Macros (experimental attribute)
| Macro | Purpose | Example |
|---|---|---|
|
Keyboard keys |
Ctrl+Shift+T → Press Ctrl+Shift+T |
|
Buttons |
Submit → Click Submit |
|
Menu navigation |
→ Select |
Press kbd:[Ctrl+C] to copy.
Click btn:[Save] to confirm.
Navigate to menu:Edit[Preferences > Display].
Icon Macros (icons: font)
| Syntax | Renders As | Use Case |
|---|---|---|
Completed items |
||
Failed/removed items |
||
Active status |
||
In progress |
||
Archived |
||
Caution indicators |
||
External links |
Currently Defined Status Icons
status-active: icon:circle[role=green] Active
status-complete: icon:check-circle[role=blue] Complete
status-archived: icon:archive[role=gray] Archived
status-planned: icon:clock[role=gray] Planned
status-in-progress: icon:spinner[role=blue]
status-done: icon:check[role=green]
| Project Alpha | {status-active} |
| Project Beta | {status-complete} |
Code Blocks & Callouts
Source Block with Highlighting
[source,bash]
----
#!/bin/bash
echo "Hello, World!"
----
Callouts (Line Annotations)
[source,bash]
----
vault write pki_int/issue/domus-client \ (1)
common_name="host.example.com" \ (2)
ttl="8760h" (3)
----
<1> PKI mount path and role
<2> Common name for certificate
<3> Time to live (1 year)
Copy-Friendly Callouts (Comment Style)
[source,bash]
----
export VAULT_ADDR="https://vault.example.com" (1)
vault login -method=ldap username="$USER" (2)
----
<1> Set Vault address
<2> Authenticate with LDAP
Attribute Substitution in Code
[source,bash,subs=attributes+]
----
ssh {person-evan}@{ise-hostname}
vault status -address=https://{vault-ip}:{vault-port}
----
Include Directive Features
Basic Include
include::partial$trackers/work/adhoc.adoc[]
Tagged Regions
// tag::carryover[]
| Task 1 | 5 days |
| Task 2 | 3 days |
// end::carryover[]
include::partial$trackers/work/adhoc.adoc[tag=carryover]
Multiple Tags
include::partial$trackers/work/projects.adoc[tags=p0;p1]
Line Ranges
include::example$script.sh[lines=10..20]
Level Offset
include::partial$section.adoc[leveloffset=+1]
Conditional Directives
ifdef/ifndef
ifdef::env-github[]
This only appears on GitHub.
endif::[]
ifndef::backend-html5[]
This appears for non-HTML output.
endif::[]
ifeval (Expressions)
ifeval::[{sectnums} == true]
Sections are numbered.
endif::[]
ifeval::["{backend}" == "html5"]
HTML-specific content here.
endif::[]
Block Types Reference
| Block | Delimiter | Purpose | Status |
|---|---|---|---|
Listing |
|
Preformatted text |
✓ Using |
Source |
|
Syntax highlighted code |
✓ Using |
Literal |
|
Literal text (no formatting) |
✓ Using |
Sidebar |
|
Supplementary content |
○ Available |
Example |
|
Illustrative examples |
✓ Using (admonitions) |
Quote |
|
Block quotations |
○ Available |
Verse |
|
Poetry/verse formatting |
○ Available |
Passthrough |
Raw HTML/SVG/unprocessed |
○ Available |
|
Comment |
|
Hidden comments |
✓ Using |
Open |
|
Generic container |
○ Available |
Table |
|
Data tables |
✓ Using |
Table Features
Column Specifiers
| Spec | Meaning | Example |
|---|---|---|
|
Proportional widths |
|
|
Left align |
|
|
Center align |
|
|
Right align |
|
|
AsciiDoc content |
|
|
Header style |
|
|
Emphasis (italic) |
|
|
Monospace |
|
|
Strong (bold) |
|
Table Options
[cols="1,2,3",options="header,footer,autowidth"]
|===
| Header 1 | Header 2 | Header 3
| Cell | Cell | Cell
| Footer 1 | Footer 2 | Footer 3
|===
Cell Spanning
|===
| Cell 1 | Cell 2 | Cell 3
2+| Spans 2 columns | Cell 3
.2+| Spans 2 rows
| Cell 2
| Cell 3
2.3+| Spans 2 cols, 3 rows
|===
STEM (Math/Science) - Not Currently Using
Enable STEM
= Document Title
:stem: asciimath
Inline Math
The formula stem:[sqrt(4) = 2] is simple.
Water (stem:[H_2O]) is essential.
Block Math
[stem]
++++
sum_(i=1)^n i^3=((n(n+1))/2)^2
++++
LaTeX Math
latexmath:[\lim_{n \to \infty}\frac{n}{\sqrt[n]{n!}} = e]
Text Formatting Quick Reference
| Markup | Renders As | Notes |
|---|---|---|
|
bold |
Strong emphasis |
|
italic |
Emphasis |
|
|
Code/literal |
|
bold italic |
Combined |
|
super |
Superscript |
|
sub |
Subscript |
|
highlight |
Marked text |
|
struck |
Strikethrough |
|
underlined |
Underline |
Cross-References
Same Component
xref:page.adoc[Link Text]
xref:folder/page.adoc#section[Section Link]
Cross-Component (Double Colon)
// TODO: Enable when infra-ops component is in playbook
// xref:infra-ops::runbooks/vyos-deployment.adoc[VyOS Runbook]
// TODO: Enable when ise-linux component is in playbook
// xref:ise-linux::02-pki/certificate-enrollment.adoc[Cert Enrollment]
With Attributes
See the xref:page.adoc[official documentation,role=external,window=_blank].
Lists
Unordered
* Item 1
** Nested item
*** Deep nested
* Item 2
Ordered
. First
. Second
.. Sub-item a
.. Sub-item b
. Third
Checklists
* [x] Completed task
* [ ] Pending task
* [*] Also completed (alternative)
Description Lists
Term 1:: Definition 1
Term 2:: Definition 2
Nested term::: Nested definition
Feature Wishlist (Not Yet Explored)
| Feature | Description | Potential Use |
|---|---|---|
|
Math/science notation |
Algorithm documentation |
Sidebar blocks |
Supplementary content |
Tips, callouts, definitions |
Quote blocks |
Block quotations |
Reference materials |
Verse blocks |
Poetry formatting |
Song lyrics, structured text |
Passthrough blocks |
Raw HTML/SVG |
Custom visualizations |
Collapsible blocks |
Expandable content |
Long examples, optional detail |
Automatic IDs |
Custom section anchors |
Deep linking control |
|
Section numbering |
Formal documents |
Maintenance Notes
Where Features Are Enabled
| Location | Features Controlled |
|---|---|
|
All global document attributes, icons, experimental, source-highlighter |
Individual |
Page-specific overrides, page-aliases |
|
Kroki extension, search, UI bundle |
Feature Dependencies
| Feature | Requires |
|---|---|
|
|
Font icons |
|
Code highlighting |
|
Section anchors |
|
Attribute warnings |
|
AsciiDoc Escape Patterns
AsciiDoc interprets {text} as attribute references. This causes build warnings when documenting shell/awk commands.
Problem
// WRONG - Antora interprets {print} as missing attribute
awk '/ERROR/ {print}'
Build warning:
WARN (asciidoctor): skipping reference to missing attribute: print
Solution: Escape Opening Brace
// CORRECT - backslash escapes the brace
awk '/ERROR/ \{print}'
Common Patterns to Escape
| Pattern | Escaped | Context |
|---|---|---|
|
|
awk print statements |
|
|
shell variable references in docs |
|
|
awk field references |
|
|
regex quantifiers |
|
|
bash parameter expansion |
Inline Code Escaping
// WRONG
The `{print}` function outputs text.
// CORRECT
The `\{print}` function outputs text.