Asciidoctor
Content entered directly below the header but before the first section heading is called the preamble.
Text formatting
This is a paragraph of regular text.
This is a paragraph with a bold word and an italicized word. Bold italic is also possible.
Words can also have internal bold and italic formatting.
Some constrained monospace text, and some unconstrained monospace text.
Some Superscript® text and some subscript text: H2O.
Links
The text at the end of this sentence is cross referenced to the third level heading
This is a link to the Asciidoctor User Manual.
This is an attribute reference {quick-uri}[which links this text to the Asciidoctor Quick Reference Guide^].
Replacements
-
copyright: ©
-
registered trademark: ®
-
trademark: ™
-
em dash (between words): —
-
ellipses: …
-
arrows: → ⇒ ← ⇐
-
apostrophe: Sam’s
-
XML entity (e.g., dagger): †
Math
Find the area under the graph of \$y = x^2\$ between \$x= 1\$ and \$x = 2\$.
\[ \int_1^2 x^2 dx = \left[ \frac{x^3}{3} \right]_1^2 = \frac{2^3}{3} - \frac{1^3}{3} = \frac{7}{3} \]
Images
Figure 1. Image caption
Footnotes
This is another paragraph.[1]
Headings
Second level heading
Third level heading
Fourth level heading
Fifth level heading
Lists
Unordered lists
Unordered list title
-
list item 1
-
nested list item
-
nested nested list item 1
-
nested nested list item 2
-
-
-
list item 2
Ordered lists
Ordered list title
-
ordered list item
-
nested ordered list item
-
-
ordered list item
-
second level list item
-
third level list item
-
another third level list item
-
a final third level list item
-
-
another second level list item
-
You can override the number scheme for any level by setting its style (the first positional entry in a block attribute list). You can also set the starting number using the start attribute:
-
Five
-
Six
-
a
-
b
-
c
-
-
Seven
Labelled lists
Here’s an example of a labeled list that identifies parts of a computer:
- CPU
-
The brain of the computer.
- Hard drive
-
Permanent storage for operating system and/or user files.
- RAM
-
Temporarily stores information the CPU uses during operation.
- Keyboard
-
Used to enter text or control items on the screen.
- Mouse
-
Used to point to and select items on your computer screen.
- Monitor
-
Displays information in visual form using text and graphics.
A horizontal labelled list
| CPU |
The brain of the computer. |
| Hard drive |
Permanent storage for operating system and/or user files. |
| RAM |
Temporarily stores information the CPU uses during operation. |
Labelled list with bullets
- Diary
-
-
Milk
-
Eggs
-
- Bakery
-
-
Bread
-
- Produce
-
-
Bananas
-
Mixed lists
Mixed unordered and ordered lists
-
Linux
-
Fedora
-
Ubuntu
-
Slackware
-
-
BSD
-
FreeBSD
-
NetBSD
-
Here’s a list that mixes all three types of lists:
- Operating Systems
-
-
Linux
-
Fedora
-
Ubuntu
-
Slackware
-
-
BSD
-
FreeBSD
-
NetBSD
-
-
- Cloud Providers
-
-
PaaS
-
OpenShift
-
CloudBees
-
-
IaaS
-
Amazon EC2
-
Rackspace
-
-
Blocks
Example 1. Example block title
Content in an example block is subject to normal substitutions.
Listing block title
Content in a listing block is subject to verbatim substitutions. Listing block content is commonly used to preserve code input.
Tables
| Column heading 1 | Column heading 2 |
|---|---|
Column 1, row 1 |
Column 2, row 1 |
Column 1, row 2 |
Column 2, row 2 |
Quotes
This is a block quote or a prose excerpt. This is subject to normal substitutions.
— firstname lastname
movie title
movie title
This is a verse block. Indents and endlines are preserved in verse blocks.
— firstname lastname
poem title and more
poem title and more
Admonitions
| This is a tip. There are five admonition labels: Tip, Note, Important, Caution and Warning. |
| This is a note. |
| This is important. |
| Caution — be careful! |
| This is a warning. |
Admonition blocks
|
A "NOTE" type admonition
This is an example of an admonition block. Unlike an admonition paragraph, it may contain any AsciiDoc content. The style can be any one of the admonition labels:
|
1. This is footnote text and will be displayed at the bottom of the article.
Input
Valid inputs are highlighted with a tick and invalid inputs are highlighted with a cross. Check it out!
text
number
email
url
password
Textarea
Button
Details
Lorem ipsum
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.