AsciiDoc Syntax Quick Reference
| The examples on this page demonstrate the output produced by the built-in HTML converter. An AsciiDoc converter is expected to produce complementary output when generating other output formats, such as PDF, EPUB, and DocBook. |
Paragraphs
Paragraphs don't require special markup in AsciiDoc.
A paragraph is defined by one or more consecutive lines of text.
Line breaks within a paragraph are not displayed.
Leave at least one empty line to begin a new paragraph.View result of Example 1
Paragraphs don’t require special markup in AsciiDoc. A paragraph is defined by one or more consecutive lines of text. Line breaks within a paragraph are not displayed.
Leave at least one empty line to begin a new paragraph.
A normal paragraph.
A literal paragraph.
One or more consecutive lines indented by at least one space.
The text is shown in a fixed-width (typically monospace) font.
The lines are preformatted (i.e., as formatted in the source).
Spaces and newlines,
like the ones in this sentence,
are preserved.View result of Example 2
A normal paragraph.
A literal paragraph. One or more consecutive lines indented by at least one space.
The text is shown in a fixed-width (typically monospace) font. The lines are preformatted (i.e., as formatted in the source). Spaces and newlines, like the ones in this sentence, are preserved.
Roses are red, +
violets are blue.
[%hardbreaks]
A ruby is red.
Java is black.View result of Example 3
Roses are red,
violets are blue.
A ruby is red.
Java is black.
[.lead]
This text will be styled as a lead paragraph (i.e., larger font).
This paragraph will not be.View result of Example 4
This text will be styled as a lead paragraph (i.e., larger font).
This paragraph will not be.
| The default Asciidoctor stylesheet automatically styles the first paragraph of the preamble as a lead paragraph if no role is specified on that paragraph. |
Text formatting
It has *strong* significance to me.
I _cannot_ stress this enough.
Type `OK` to accept.
That *_really_* has to go.
Can't pick one? Let's use them `*_all_*`.View result of Example 5
It has strong significance to me.
I cannot stress this enough.
Type OK to accept.
That really has to go.
Can’t pick one? Let’s use them all.
**C**reate, **R**ead, **U**pdate, and **D**elete (CRUD)
That's fan__freakin__tastic!
Don't pass generic ``Object``s to methods that accept ``String``s!
It was Beatle**__mania__**!View result of Example 6
Create, Read, Update, and Delete (CRUD)
That’s fanfreakintastic!
Don’t pass generic Objects to methods that accept Strings!
It was Beatlemania!
Mark my words, #automation is essential#.
##Mark##up refers to text that contains formatting ##mark##s.
Where did all the [.underline]#cores# go?
We need [.line-through]#ten# twenty VMs.
A [.myrole]#custom role# must be fulfilled by the theme.View result of Example 7
Mark my words, automation is essential.
Markup refers to text that contains formatting marks.
Where did all the cores go?
We need ten twenty VMs.
A custom role must be fulfilled by the theme.
^super^script
~sub~scriptView result of Example 8
superscript
subscript
"`double curved quotes`"
'`single curved quotes`'
Olaf's desk was a mess.
A ``std::vector```'s size is the number of items it contains.
All of the werewolves`' desks were a mess.
Olaf had been with the company since the `'00s.View result of Example 9
“double curved quotes”
‘single curved quotes’
Olaf’s desk was a mess.
A std::vector’s size is the number of items it contains.
All of the werewolves’ desks were a mess.
Olaf had been with the company since the ’00s.
Links
https://asciidoctor.org - automatic!
https://asciidoctor.org[Asciidoctor]
devel@discuss.example.org
mailto:devel@discuss.example.org[Discuss]
mailto:join@discuss.example.org[Subscribe,Subscribe me,I want to join!]View result of Example 10
https://chat.asciidoc.org[Discuss AsciiDoc,role=external,window=_blank]
https://chat.asciidoc.org[Discuss AsciiDoc^]View result of Example 11
The link: macro prefix is not required when the target starts with a URL scheme like https:.
The URL scheme acts as an implicit macro prefix.
|
| If the link text contains a comma and the text is followed by one or more named attributes, you must enclose the text in double quotes. Otherwise, the text will be cut off at the comma (and the remaining text will get pulled into the attribute parsing). |
link:++https://example.org/?q=[a b]++[URL with special characters]
https://example.org/?q=%5Ba%20b%5D[URL with special characters]link:index.html[Docs]link:\\server\share\whitepaper.pdf[Whitepaper][[bookmark-a]]Inline anchors make arbitrary content referenceable.
[#bookmark-b]#Inline anchors can be applied to a phrase like this one.#
anchor:bookmark-c[]Use a cross reference to link to this location.
[[bookmark-d,last paragraph]]The xreflabel attribute will be used as link text in the cross-reference link.See <<paragraphs>> to learn how to write paragraphs.
Learn how to organize the document into <<section-titles,sections>>.View result of Example 16
See Paragraphs to learn how to write paragraphs.
Learn how to organize the document into sections.
Refer to xref:document-b.adoc#section-b[Section B of Document B] for more information.
If you never return from xref:document-b.adoc[Document B], we'll send help.Document header
The document header is optional. The header may not contain any empty lines and must be separated from the content by at least one empty line.
= Document Title
This document provides...= Document Title
Author Name <author@email.org>
This document provides...= Document Title
Author Name <author@email.org>; Another Author <a.author@email.org>
v2.0, 2019-03-22
This document provides...| You cannot have a revision line without an author line. |
= Document Title
Author Name <author@email.org>
v2.0, 2019-03-22
:toc:
:homepage: https://example.org
This document provides...Section titles
When the document type is article (the default), the document can only have one level 0 section title (=), which is the document title (i.e., doctitle).
= Document Title (Level 0)
== Level 1 Section Title
=== Level 2 Section Title
==== Level 3 Section Title
===== Level 4 Section Title
====== Level 5 Section Title
== Another Level 1 Section TitleView result of Example 22
Document Title (Level 0)
Level 1 Section Title
Level 2 Section Title
Level 3 Section Title
Level 4 Section Title
Level 5 Section Title
Another Level 1 Section Title
The book document type can have additional level 0 section titles, which are interpreted as parts.
The presence of at least one part implicitly makes the document a multi-part book.
= Document Title (Level 0)
== Level 1 Section Title
= Level 0 Section Title (Part)
== Level 1 Section Title
=== Level 2 Section Title
==== Level 3 Section Title
===== Level 4 Section Title
====== Level 5 Section Title
= Another Level 0 Section Title (Part)[discrete]
=== I'm an independent heading!
This paragraph is it's sibling, not it's child.View result of Example 24
I’m an independent heading!
This paragraph is it’s sibling, not it’s child.
Automatic TOC
= Document Title
Doc Writer <doc.writer@email.org>
:toc:The Table of Content’s title, displayed section depth, and position can be customized.
Includes
= Reference Documentation
Lead Developer
This is documentation for project X.
include::basics.adoc[]
include::installation.adoc[]
include::example.adoc[]include::filename.txt[tag=definition]
include::filename.txt[lines=5..10]include::https://raw.githubusercontent.com/asciidoctor/asciidoctor/main/README.adoc[]
Including content from a URL is potentially dangerous, so it’s disabled if the safe mode is SECURE or greater.
Assuming the safe mode is less than SECURE, you must also set the allow-uri-read attribute to permit the AsciiDoc processor to read content from a URL.
|
Lists
* List item
** Nested list item
*** Deeper nested list item
* List item
** Another nested list item
* List itemView result of Example 29
-
List item
-
Nested list item
-
Deeper nested list item
-
-
-
List item
-
Another nested list item
-
-
List item
An empty line is required before and after a list to separate it from other blocks.
You can force two adjacent lists apart by adding an empty attribute list (i.e., []) above the second list or by inserting an empty line followed by a line comment after the first list.
If you use a line comment, the convention is to use //- to provide a hint to other authors that it’s serving as a list divider.
|
* Level 1 list item
** Level 2 list item
*** Level 3 list item
**** Level 4 list item
***** Level 5 list item
****** etc.
* Level 1 list itemView result of Example 30
-
Level 1 list item
-
Level 2 list item
-
Level 3 list item
-
Level 4 list item
-
Level 5 list item
-
etc.
-
-
-
-
-
-
Level 1 list item
The unordered list marker can be changed using a list style (e.g., square).
. Step 1
. Step 2
.. Step 2a
.. Step 2b
. Step 3View result of Example 31
-
Step 1
-
Step 2
-
Step 2a
-
Step 2b
-
-
Step 3
. Level 1 list item
.. Level 2 list item
... Level 3 list item
.... Level 4 list item
..... Level 5 list item
. Level 1 list itemView result of Example 32
-
Level 1 list item
-
Level 2 list item
-
Level 3 list item
-
Level 4 list item
-
Level 5 list item
-
-
-
-
-
Level 1 list item
Ordered lists support numeration styles such as lowergreek and decimal-leading-zero.
* [*] checked
* [x] also checked
* [ ] not checked
* normal list itemView result of Example 33
-
checked
-
also checked
-
not checked
-
normal list item
First term:: The description can be placed on the same line
as the term.
Second term::
Description of the second term.
The description can also start on its own line.View result of Example 34
- First term
-
The description can be placed on the same line as the term.
- Second term
-
Description of the second term. The description can also start on its own line.
[qanda]
What is the answer?::
This is the answer.
Are cameras allowed?::
Are backpacks allowed?::
No.View result of Example 35
-
What is the answer?
This is the answer.
-
Are cameras allowed?
Are backpacks allowed?
No.
Operating Systems::
Linux:::
. Fedora
* Desktop
. Ubuntu
* Desktop
* Server
BSD:::
. FreeBSD
. NetBSD
Cloud Providers::
PaaS:::
. OpenShift
. CloudBees
IaaS:::
. Amazon EC2
. RackspaceView result of Example 36
- Operating Systems
-
- Linux
-
-
Fedora
-
Desktop
-
-
Ubuntu
-
Desktop
-
Server
-
-
- BSD
-
-
FreeBSD
-
NetBSD
-
- Cloud Providers
-
- PaaS
-
-
OpenShift
-
CloudBees
-
- IaaS
-
-
Amazon EC2
-
Rackspace
-
| Lists can be indented. Leading whitespace is not significant. |
* Every list item has at least one paragraph of content,
which may be wrapped, even using a hanging indent.
+
Additional paragraphs or blocks are adjoined by putting
a list continuation on a line adjacent to both blocks.
+
list continuation:: a plus sign (`{plus}`) on a line by itself
* A literal paragraph does not require a list continuation.
$ cd projects/my-book
* AsciiDoc lists may contain any complex content.
+
|===
|Column 1, Header Row |Column 2, Header Row
|Column 1, Row 1
|Column 2, Row 1
|===View result of Example 37
-
Every list item has at least one paragraph of content, which may be wrapped, even using a hanging indent.
Additional paragraphs or blocks are adjoined by putting a list continuation on a line adjacent to both blocks.
- list continuation
-
a plus sign (
+) on a line by itself
-
A literal paragraph does not require a list continuation.
$ cd projects/my-book
-
AsciiDoc lists may contain any complex content.
Column 1, Header Row Column 2, Header Row Column 1, Row 1
Column 2, Row 1
Images
You can use the imagesdir attribute to avoid hard coding the common path to your images in every image macro.
The value of this attribute can be an absolute path, relative path, or base URL.
If the image target is a relative path, the attribute’s value is prepended (i.e., it’s resolved relative to the value of the imagesdir attribute).
If the image target is a URL or absolute path, the attribute’s value is not prepended.
image::sunset.jpg[]
image::sunset.jpg[Sunset]
.A mountain sunset
[#img-sunset,caption="Figure 1: ",link=https://www.flickr.com/photos/javh/5448336655]
image::macros:sunset.jpg[Sunset,200,100]
image::https://asciidoctor.org/images/octocat.jpg[GitHub mascot]View result of Example 38
Two colons following the image keyword in the macro (i.e., image::) indicates a block image (aka figure), whereas one colon following the image keyword (i.e., image:) indicates an inline image.
(All macros follow this pattern).
You use an inline image when you need to place the image in a line of text.
Otherwise, you should prefer the block form.
Click image:play.png[] to get the party started.
Click image:pause.png[title="Pause"] when you need a break.View result of Example 39
Click 
to get the party started.
Click 
when you need a break.
image:sunset.jpg[Sunset,150,150,role=right] What a beautiful sunset!View result of Example 40
What a beautiful sunset!
= Document Title
:data-uri:When the data-uri attribute is set, all images in the document—including admonition icons—are embedded into the document as data URIs.
You can also pass it as a command line argument using -a data-uri.
Audio
audio::ocean-waves.wav[]
audio::ocean-waves.wav[start=60,opts=autoplay]You can control the audio settings using additional attributes and options on the macro.
Videos
video::video-file.mp4[]
video::video-file.mp4[width=640,start=60,opts=autoplay]video::RvRhUHTV_8k[youtube]video::67480300[vimeo]You can control the video settings using additional attributes and options on the macro.
Keyboard, button, and menu macros
You must set the experimental attribute in the document header to enable these macros.
|
|===
|Shortcut |Purpose
|kbd:[F11]
|Toggle fullscreen
|kbd:[Ctrl+T]
|Open a new tab
|===View result of Example 46
| Shortcut | Purpose |
|---|---|
F11 |
Toggle fullscreen |
Ctrl+T |
Open a new tab |
View result of Example 47
To save the file, select .
Select to reset the zoom level to the default setting.
View result of Example 48
Press the OK button when you are finished.
Select a file in the file navigator and click Open.
Literals and source code
Output literal monospace text, such as `+{backtick}+` or `+http://localhost:8080+`, by enclosing the text in a pair of pluses surrounded by a pair backticks.View result of Example 49
Output literal monospace text, such as {backtick} or http://localhost:8080, by enclosing the text in a pair of pluses surrounded by a pair backticks.
Normal line.
Indent line by one space to create a literal line.
Normal line.View result of Example 50
Normal line.
Indent line by one space to create a literal line.
Normal line.
....
error: 1954 Forbidden search
absolutely fatal: operation lost in the dodecahedron of doom
Would you like to try again? y/n
....View result of Example 51
error: 1954 Forbidden search absolutely fatal: operation lost in the dodecahedron of doom Would you like to try again? y/n
.Gemfile.lock
----
GEM
remote: https://rubygems.org/
specs:
asciidoctor (2.0.15)
PLATFORMS
ruby
DEPENDENCIES
asciidoctor (~> 2.0.15)
----View result of Example 52
GEM
remote: https://rubygems.org/
specs:
asciidoctor (2.0.15)
PLATFORMS
ruby
DEPENDENCIES
asciidoctor (~> 2.0.15)
.Some Ruby code
[source,ruby]
----
require 'sinatra'
get '/hi' do
"Hello World!"
end
----View result of Example 53
require 'sinatra'
get '/hi' do
"Hello World!"
end|
You must enable source highlighting by setting the See Syntax Highlighting to learn which values are accepted when using Asciidoctor. |
[source,ruby]
----
require 'sinatra' // <1>
get '/hi' do // <2>
"Hello World!" // <3>
end
----
<1> Library import
<2> URL mapping
<3> HTTP response bodyView result of Example 54
require 'sinatra' (1)
get '/hi' do (2)
"Hello World!" (3)
end| 1 | Library import |
| 2 | URL mapping |
| 3 | HTTP response body |
----
line of code // <1>
line of code # <2>
line of code ;; <3>
line of code <!--4-->
----
<1> A callout behind a line comment for C-style languages.
<2> A callout behind a line comment for Ruby, Python, Perl, etc.
<3> A callout behind a line comment for Clojure.
<4> A callout behind a line comment for XML or SGML languages like HTML.View result of Example 55
line of code (1)
line of code (2)
line of code (3)
line of code (4)| 1 | A callout behind a line comment for C-style languages. |
| 2 | A callout behind a line comment for Ruby, Python, Perl, etc. |
| 3 | A callout behind a line comment for Clojure. |
| 4 | A callout behind a line comment for XML or SGML languages like HTML. |
[,ruby]
----
include::app.rb[]
----:sourcedir: src/main/java
[source,java]
----
include::{sourcedir}/org/asciidoctor/Asciidoctor.java[]
----[source,ruby]
----
include::lib/app.rb[tag=main,indent=0]
----|
The indent attribute is frequently used when including source code by tagged region or lines. It can be specified on the include directive itself or the enclosing literal, listing, or source block. When indent is 0, the leading block indent is stripped. When indent is greater than 0, the leading block indent is first stripped, then a block is indented by the number of columns equal to this value. |
[source,xml]
<meta name="viewport"
content="width=device-width, initial-scale=1.0">
This is normal content.View result of Example 59
<meta name="viewport"
content="width=device-width, initial-scale=1.0">This is normal content.
Admonitions
NOTE: An admonition draws the reader's attention to auxiliary information.
Here are the other built-in admonition types:
IMPORTANT: Don't forget the children!
TIP: Look for the warp zone under the bridge.
CAUTION: Slippery when wet.
WARNING: The software you're about to use is untested.
IMPORTANT: Sign off before stepping away from your computer.View result of Example 60
| An admonition draws the reader’s attention to auxiliary information. |
Here are the other built-in admonition types:
| Don’t forget the children! |
| Look for the warp zone under the bridge. |
| Slippery when wet. |
| The software you’re about to use is untested. |
| Sign off before stepping away from your computer. |
[NOTE]
====
An admonition block may contain complex content.
.A list
- one
- two
- three
Another paragraph.
====View result of Example 61
|
An admonition block may contain complex content. A list
Another paragraph. |
More delimited blocks
Any block can have a title. A block title is defined using a line of text above the block that starts with a dot. That dot cannot be followed by a space. For block images, the title is displayed below the block. For all other blocks, the title is typically displayed above it.
View result of Example 62
====
Here's a sample AsciiDoc document:
----
= Title of Document
Doc Writer
:toc:
This guide provides...
----
The document header is useful, but not required.
====View result of Example 63
Here’s a sample AsciiDoc document:
= Title of Document
Doc Writer
:toc:
This guide provides...The document header is useful, but not required.
[quote,Abraham Lincoln,Address delivered at the dedication of the Cemetery at Gettysburg]
____
Four score and seven years ago our fathers brought forth
on this continent a new nation...
____
[quote,Albert Einstein]
A person who never made a mistake never tried anything new.
____
A person who never made a mistake never tried anything new.
____
[quote,Charles Lutwidge Dodgson,'Mathematician and author, also known as https://en.wikipedia.org/wiki/Lewis_Carroll[Lewis Carroll]']
____
If you don't know where you are going, any road will get you there.
____
"I hold it that a little rebellion now and then is a good thing,
and as necessary in the political world as storms in the physical."
-- Thomas Jefferson, Papers of Thomas Jefferson: Volume 11View result of Example 64
Four score and seven years ago our fathers brought forth on this continent a new nation…
Address delivered at the dedication of the Cemetery at Gettysburg
A person who never made a mistake never tried anything new.
A person who never made a mistake never tried anything new.
If you don’t know where you are going, any road will get you there.
Mathematician and author, also known as Lewis Carroll
I hold it that a little rebellion now and then is a good thing, and as necessary in the political world as storms in the physical.
Papers of Thomas Jefferson: Volume 11
--
An open block can be an anonymous container,
or it can masquerade as any other block.
--
[source]
--
puts "I'm a source block!"
--View result of Example 65
An open block can be an anonymous container, or it can masquerade as any other block.
puts "I'm a source block!"++++
<p>
Content in a passthrough block is passed to the output unprocessed.
That means you can include raw HTML, like this embedded Gist:
</p>
<script src="https://gist.github.com/mojavelinux/5333524.js">
</script>
++++View result of Example 66
Content in a passthrough block is passed to the output unprocessed. That means you can include raw HTML, like this embedded Gist:
:release-version: 2.4.3
[source,xml,subs=attributes+]
----
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj</artifactId>
<version>{release-version}</version>
</dependency>
----View result of Example 67
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj</artifactId>
<version>2.4.3</version>
</dependency>Tables
.Table Title
|===
|Column 1, Header Row |Column 2, Header Row (1)
(2)
|Cell in column 1, row 1
|Cell in column 2, row 1
|Cell in column 1, row 2
|Cell in column 2, row 2
|===| 1 | Unless the cols attribute is specified, the number of columns is equal to the number of cell separators on the first (non-empty) line. |
| 2 | When an empty line immediately follows a non-empty line at the start of the table, the cells in the first line get promoted to the table header. |
View result of Example 68
| Column 1, Header Row | Column 2, Header Row |
|---|---|
Cell in column 1, row 1 |
Cell in column 2, row 1 |
Cell in column 1, row 2 |
Cell in column 2, row 2 |
[%header,cols=2*] (1)
|===
|Name of Column 1
|Name of Column 2
|Cell in column 1, row 1
|Cell in column 2, row 1
|Cell in column 1, row 2
|Cell in column 2, row 2
|===| 1 | The * in the cols attribute is the repeat operator.
It means repeat the column specification across the remaining columns.
In this case, we are repeating the default formatting across 2 columns.
When the cells in the header are not defined on a single line, you must use the cols attribute to set the number of columns in the table and the %header option (or options=header attribute) to promote the first row to the table header. |
View result of Example 69
| Name of Column 1 | Name of Column 2 |
|---|---|
Cell in column 1, row 1 |
Cell in column 2, row 1 |
Cell in column 1, row 2 |
Cell in column 2, row 2 |
.Applications
[cols="1,1,2"] (1)
|===
|Name |Category |Description
|Firefox
|Browser
|Mozilla Firefox is an open source web browser.
It's designed for standards compliance,
performance, portability.
|Arquillian
|Testing
|An innovative and highly extensible testing platform.
Empowers developers to easily create real, automated tests.
|===| 1 | In this example, the cols attribute has two functions.
It specifies that this table has three columns, and it sets their relative widths. |
View result of Example 70
| Name | Category | Description |
|---|---|---|
Firefox |
Browser |
Mozilla Firefox is an open source web browser. It’s designed for standards compliance, performance, portability. |
Arquillian |
Testing |
An innovative and highly extensible testing platform. Empowers developers to easily create real, automated tests. |
[cols="2,2,5a"]
|===
|Firefox
|Browser
|Mozilla Firefox is an open source web browser.
It's designed for:
* standards compliance
* performance
* portability
https://getfirefox.com[Get Firefox]!
|===View result of Example 71
Firefox |
Browser |
Mozilla Firefox is an open source web browser. It’s designed for:
|
,===
Artist,Track,Genre
Baauer,Harlem Shake,Hip Hop
,===View result of Example 72
| Artist | Track | Genre |
|---|---|---|
Baauer |
Harlem Shake |
Hip Hop |
[%header,format=csv]
|===
Artist,Track,Genre
Baauer,Harlem Shake,Hip Hop
The Lumineers,Ho Hey,Folk Rock
|===View result of Example 73
| Artist | Track | Genre |
|---|---|---|
Baauer |
Harlem Shake |
Hip Hop |
The Lumineers |
Ho Hey |
Folk Rock |
|===
include::customers.csv[]
|===:===
Artist:Track:Genre
Robyn:Indestructible:Dance
:===View result of Example 75
| Artist | Track | Genre |
|---|---|---|
Robyn |
Indestructible |
Dance |
[cols="e,m,^,>s",width="25%"]
|===
|1 >s|2 |3 |4
^|5 2.2+^.^|6 .3+<.>m|7
^|8
|9 2+>|10
|===View result of Example 76
1 |
2 |
3 |
4 |
5 |
|
|
|
8 |
|||
9 |
|
||
IDs, roles, and options
[#goals.incremental]
* Goal 1
* Goal 2
|
[id="goals",role="incremental"]
* Goal 1
* Goal 2[#null-values]
== Primitive types and null values[#id-name.role-name]`monospace text`
[#free-world.goals]*free the world*[%header%footer%autowidth]
|===
|Header A |Header B
|Footer A |Footer B
|===[options="header,footer,autowidth"]
|===
|Header A |Header B
|Footer A |Footer B
|===
// options can be shorted to opts
[opts="header,footer,autowidth"]
|===
|Header A |Header B
|Footer A |Footer B
|===Comments
// A single-line comment
////
A multi-line comment.
Notice it's a delimited block.
////Breaks
before
'''
afterView result of Example 84
before
after
<<<Attributes and substitutions
:url-home: https://asciidoctor.org
:link-docs: https://asciidoctor.org/docs[documentation]
:summary: AsciiDoc is a mature, plain-text document format for \
writing notes, articles, documentation, books, and more. \
It's also a text processor & toolchain for translating \
documents into various output formats (i.e., backends), \
including HTML, DocBook, PDF and ePub.
:checkedbox: pass:normal[{startsb}✔{endsb}]
Check out {url-home}[Asciidoctor]!
{summary}
Be sure to read the {link-docs} too!
{checkedbox} That's done!View result of Example 86
Check out Asciidoctor! AsciiDoc is a mature, plain-text document format for writing notes, articles, documentation, books, and more. It’s also a text processor & toolchain for translating documents into various output formats (i.e., backends), including HTML, DocBook, PDF and ePub. Be sure to read the documentation too! [✔] That’s done! |
To learn more about the available attributes and substitution groups see:
.Parts{counter2:index:0}
|===
|Part Id |Description
|PX-{counter:index}
|Description of PX-{index}
|PX-{counter:index}
|Description of PX-{index}
|===View result of Example 87
| Part Id | Description |
|---|---|
PX-1 |
Description of PX-1 |
PX-2 |
Description of PX-2 |
Text replacements
| Name | Syntax | Unicode Replacement | Rendered | Notes |
|---|---|---|---|---|
Copyright |
(C) |
© |
© |
|
Registered |
(R) |
® |
® |
|
Trademark |
(TM) |
™ |
™ |
|
Em dash |
-- |
— |
— |
Only replaced if between two word characters, between a word character and a line boundary, or flanked by spaces. When flanked by space characters (e.g., |
Ellipsis |
... |
… |
… |
The ellipsis is followed by a zero-width space (​) to provide a break opportunity. |
Single right arrow |
-> |
→ |
→ |
|
Double right arrow |
=> |
⇒ |
⇒ |
|
Single left arrow |
<- |
← |
← |
|
Double left arrow |
<= |
⇐ |
⇐ |
|
Typographic apostrophe |
Sam's |
Sam’s |
Sam’s |
The typewriter apostrophe is replaced with the typographic (aka curly or smart) apostrophe. |
Any named, numeric or hexadecimal XML character reference is supported.
Escaping substitutions
In /items/\{id}, the id attribute isn't replaced.
The curly braces around it are preserved.
\*Stars* isn't displayed as bold text.
The asterisks around it are preserved.
\§ appears as an entity reference.
It's not converted into the section symbol (§).
\=> The backslash prevents the equals sign followed by a greater
than sign from combining to form a double arrow character (=>).
\[[Word]] is not interpreted as an anchor.
The double brackets around it are preserved.
[\[[Word]]] is not interpreted as a bibliography anchor.
The triple brackets around it are preserved.
The URL \https://example.org isn't converted into an active link.View result of Example 88
In /items/{id}, the id attribute isn’t replaced. The curly braces around it are preserved.
*Stars* isn’t displayed as bold text. The asterisks around it are preserved.
§ appears as an entity reference. It’s not converted into the section symbol (§).
=> The backslash prevents the equals sign followed by a greater than sign from combining to form a double arrow character (⇒).
[[Word]] is not interpreted as an anchor. The double brackets around it are preserved.
[[[Word]]] is not interpreted as a bibliography anchor. The triple brackets around it are preserved.
The URL https://example.org isn’t converted into an active link.
A word or phrase between single pluses, such as +/user/{id}+,
is not substituted.
However, the special characters like +<+ and +>+ are still
escaped in the output.
An attribute reference within a word, such as dev++{conf}++,
is not replaced.
A plus passthrough will escape standalone formatting marks,
like +``+, or formatting marks within a word, like all-natural++*++.View result of Example 89
A word or phrase between single pluses, such as /user/{id}, is not substituted. However, the special characters like < and > are still escaped in the output.
An attribute reference within a word, such as dev{conf}, is not replaced.
A plus passthrough will escape standalone formatting marks, like ``, or formatting marks within a word, like all-natural*.
+++<u>underline me</u>+++ is underlined.
pass:[<u>underline me</u>] is also underlined.View result of Example 90
underline me is underlined.
underline me is also underlined.
Bibliography
_The Pragmatic Programmer_ <<pp>> should be required reading for all developers.
To learn all about design patterns, refer to the book by the "`Gang of Four`" <<gof>>.
[bibliography]
== References
* [[[pp]]] Andy Hunt & Dave Thomas. The Pragmatic Programmer:
From Journeyman to Master. Addison-Wesley. 1999.
* [[[gof,gang]]] Erich Gamma, Richard Helm, Ralph Johnson & John Vlissides.
Design Patterns: Elements of Reusable Object-Oriented Software. Addison-Wesley. 1994.View result of Example 91
Footnotes
A statement.footnote:[Clarification about this statement.]
A bold statement!footnote:disclaimer[Opinions are my own.]
Another bold statement.footnote:disclaimer[]Markdown compatibility
Markdown compatible syntax is an optional feature of the AsciiDoc language and is currently only available when using Asciidoctor.
# Document Title (Level 0)
## Section Level 1
### Section Level 2
#### Section Level 3
##### Section Level 4
###### Section Level 5View result of Example 93
Document Title (Level 0)
Section Level 1
Section Level 2
Section Level 3
Section Level 4
Section Level 5
```ruby
require 'sinatra'
get '/hi' do
"Hello World!"
end
```View result of Example 94
require 'sinatra'
get '/hi' do
"Hello World!"
end> I hold it that a little rebellion now and then is a good thing,
> and as necessary in the political world as storms in the physical.
> -- Thomas Jefferson, Papers of Thomas Jefferson: Volume 11View result of Example 95
I hold it that a little rebellion now and then is a good thing, and as necessary in the political world as storms in the physical.
Papers of Thomas Jefferson: Volume 11
> > What's new?
>
> I've got Markdown in my AsciiDoc!
>
> > Like what?
>
> * Blockquotes
> * Headings
> * Fenced code blocks
>
> > Is there more?
>
> Yep. AsciiDoc and Markdown share a lot of common syntax already.View result of Example 96
What’s new?
I’ve got Markdown in my AsciiDoc!
Like what?
Blockquotes
Headings
Fenced code blocks
Is there more?
Yep. AsciiDoc and Markdown share a lot of common syntax already.
---
- - -
***
* * *