Asciidoctor Examples
🎉4 hours ago • ☕️☕️☕️ 16 min read • Comments
:!showtitle:
:!sectnums:
:sectids:
:toc: auto
:sectlinks:
:sectanchors:
:idprefix:
:idseparator: -
:xrefstyle: full
:!example-caption:
:!figure-caption:
:!table-caption:
:!listing-caption:
:icons: font
:experimental:
:!prewrap:
Text
Paragraphs
This is Asciidoc. The following is a sample of Asciidoc. To start a new line,
add +
at the end of the line or use the hardbreaks option.
New line using +
.
Lead Style
Blockquotes
Source blocks (
[source]
) can also be used in citations.
additional information
abc
— nest
Lists
Ordered List
-
List item 1
-
List item 2
-
Indented level 2
-
Indented level 3
-
-
-
List item 3
Unordered List
-
List item 1
-
List item 2
-
Indented level 2
-
Indented level 3
-
Indented level 4
-
Indented level 5
-
-
-
-
-
List item 3
Markers
-
item1
-
item2
-
item3
-
-
item1
-
item2
-
item3
-
-
item1
-
item2
-
item3
-
-
item1
-
item2
-
item3
-
-
item1
-
item2
-
item3
-
Description List
- 0
-
123456789
- A
-
BCDEF
- a
-
bcdef
0 |
123456789 |
A |
BCDEF
|
-
ABCDEF
abcdef
Inline elements
-
This is bold (strong) text.
-
red color
-
This is italic (emphasis) text.
-
This is underlined text.
-
This text is deletedand This text is inserted. -
This text has a strikethrough. -
Superscript®.
-
Subscript for things like H2O.
-
This small text is small for for fine print, etc.
-
The mark element indicates a highlight.
-
Image
User Interface Macros
Must set the experimental attribute. ( |
Display |
|
Keyboard shortcuts |
|
CTRL+H |
|
CTRL+SHIFT+i |
|
CTRL+ALT+R |
|
\ |
|
CTRL+] |
|
Meta++ |
|
Menu selections |
|
Home |
|
|
|
|
|
UI Buttons |
|
Cancel |
|
NG |
|
Icons
Display |
|
|
|
|
|
|
|
|
|
|
|
|
|
icon:heart[]
icon:heart[size=fw, role="red"]
icon:heart[lg, role="fuchsia"]
icon:bolt[fw, role="yellow"]
icon:shield[fw, role="silver"]
Tabular data
Table Heading 1 | Table Heading 2 | Table Heading 3 | Table Heading 4 | Table Heading 5 |
---|---|---|---|---|
Table Cell 1 |
Table Cell 2 |
Table Cell 3 |
Table Cell 4 |
Table Cell 5 |
Table Cell 1 |
Table Cell 2 |
Table Cell 3 |
Table Cell 4 |
Table Cell 5 |
Table Cell 1 |
Table Cell 2 |
Table Cell 3 |
Table Cell 4 |
Table Cell 5 |
Table Cell 1 |
Table Cell 2 |
Table Cell 3 |
Table Cell 4 |
Table Cell 5 |
Table Footer 1 |
Table Footer 2 |
Table Footer 3 |
Table Footer 4 |
Table Footer 5 |
Format
Format |
display |
align |
|
horizontal |
|
left |
< |
center |
^ |
right |
> |
vertical |
|
left |
.< |
left |
.^ |
left |
.> |
style |
|
Asciidoc |
|
Emphasis |
Emphasis |
Header |
Header |
---|---|
Literal |
Literal |
Monospaced |
|
Default |
Default style |
Strong |
Strong |
Verse |
Verse |
Asciidoc block
Element |
Display |
||
Unordered List |
|
||
Ordered List |
|
||
Table |
|
||
Source code |
|
||
Example |
example |
||
Admonition |
|
Strip
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
* |
0 |
# |
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
* |
0 |
# |
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
* |
0 |
# |
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
* |
0 |
# |
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
* |
0 |
# |
Code
-
Inline code:
<div>code</div>
-
Pre-formatted text:
P R E F O R M A T T E D T E X T ! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a b c d e f g h i j k l m n o p q r s t u v w x y z { | } ~
0123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
[source, Asciidoc]
------
abcdef (1)
------
1 | conum |
Admonition
If you want to display following icons, you must set |
Note
Note |
TIP
TIP |
IMPORTANT
IMPORTANT |
CAUTION
CAUTION |
WARNING
WARNING |
Form elements
Checkboxes
-
Choice A (checked)
-
Choice B (also checked)
-
Choice C (not checked)
-
normal list item
-
checked
-
also checked
-
not checked
-
normal list item
Collapsible
Details
collapsible
Heading 1
Heading 1
Heading 2
Heading 2
Heading 3
Heading 3
Heading 4
Heading 4
Heading 5
Heading 5
Heading 6
Heading 6
LICENSE
This document is licensed under MIT.
The MIT License (MIT)
Copyright (c) 2019 hitsuji no shippo
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
The MIT License (MIT)
Copyright (c) 2016 Darshan Soni
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Edit • View history in GitHub.