AsciiDoc

Knowledge, guides and tips for using AsciiDoc.

Template

Template with comments explaining given adoc elements.

// Enable section numbers
:sectnums:

// Define value
:blog-url: komidawi.it

// Title
= Title

// Version number
:revnumber: 1.0.0

// Enable syntax highlighting and set highlighter
:source-highlighter: rouge

// Define section
[#section-name]

// Use value in text
Here we use my {blog-url}[defined URL]
Or just an https://komidawi.it[inline URL]

// Make a newline
Here's a line +
break

// Visit defined section
Go back to <<section-name,Defined Section>>

// Special blocks
TIP: Tip
NOTE: Note
IMPORTANT: Important
CAUTION: Caution

// Block title
.Sidebar block

// Sidebar block
****
Some information
****

// Unordered list
* Level 1
** Level 2
*** Level 3

// Ordered list
. Item 1
. Item 2
.. Item 2.1

// Checklist
* [ ] Checkbox 1
* [ ] Checkbox 2
* [ ] Checkbox 3

// Horizontal line
'''

// Code block
[,shell]
----
ls -al
----