About
AsciiDoc is a lightweight markup language for authoring notes, articles, documentation, books, web pages, slide decks and man pages in plain text.
This guide is a quick reference for the common AsciiDoc document and text formatting markup.
|
These examples focus on the output generated by the HTML backend. AsciiDoc produces complementary output when generating PDF, EPUB, and DocBook. |
1. Paragraphs
Paragraphs don't require any special markup in AsciiDoc. A paragraph is just one or more lines of consecutive text. To begin a new paragraph, separate it by at least one blank line. Newlines within a paragraph are not displayed.
Paragraphs don’t require any special markup in AsciiDoc. A paragraph is just one or more lines of consecutive text.
To begin a new paragraph, separate it by at least one blank line. Newlines within a paragraph are not displayed.
Rubies are red, + Topazes are blue. [%hardbreaks] Ruby is red. Java is black.
Rubies are red,
Topazes are blue.
Ruby is red.
Java is black.
A normal paragraph. A paragraph offset by at least one space becomes a literal paragraph. All lines in a literal paragraph must be adjacent. A literal paragraph is displayed as preformatted text. The text is shown in a fixed-width font. Spaces and newlines, like the ones in this sentence, are preserved. Another normal paragraph.
A normal paragraph.
A paragraph offset by at least one space becomes a literal paragraph. All lines in a literal paragraph must be adjacent.
A literal paragraph is displayed as preformatted text. The text is shown in a fixed-width font. Spaces and newlines, like the ones in this sentence, are preserved.
Another normal paragraph.
NOTE: An admonition paragraph draws the reader's attention to auxiliary information. Its purpose is determined by the label at the beginning of the paragraph. Here are the other built-in admonition types: TIP: Pro tip... IMPORTANT: Don't forget... WARNING: Watch out for... CAUTION: Ensure that...
| An admonition paragraph draws the reader’s attention to auxiliary information. Its purpose is determined by the label at the beginning of the paragraph. |
Here are the other built-in admonition types:
| Pro tip… |
| Don’t forget… |
| Watch out for… |
| Ensure that… |
| You can also create admonition blocks. |
[.lead] This text will be styled as a lead paragraph (i.e., larger font).
This text will be styled as a lead paragraph (i.e., larger font).
| The default Asciidoctor stylesheet automatically styles the first paragraph of the preamble as a lead paragraph. |
2. Formatted Text
*bold phrase* & **char**acter**s** _italic phrase_ & __char__acter__s__ *_bold italic phrase_* & **__char__**acter**__s__** `monospace phrase` & ``char``acter``s`` `*monospace bold phrase*` & ``**char**``acter``**s**`` `_monospace italic phrase_` & ``__char__``acter``__s__`` `*_monospace bold italic phrase_*` & ``**__char__**``acter``**__s__**``
bold phrase & characters
italic phrase & characters
bold italic phrase & characters
monospace phrase & characters
monospace bold phrase & characters
monospace italic phrase & characters
monospace bold italic phrase &
characters
Werewolves are allergic to #cassia cinnamon#. Did the werewolves read the [.small]#small print#? Where did all the [.underline]#cores# run off to? We need [.line-through]#ten# make that twenty VMs. [.big]##O##nce upon an infinite loop.
Werewolves are allergic to cassia cinnamon.
Did the werewolves read the small print?
Where did all the cores run off to?
We need ten make that twenty VMs.
Once upon an infinite loop.
^super^script phrase ~sub~script phrase
superscript phrase
subscript phrase
"`double curved quotes`" '`single curved quotes`' Olaf's desk was a mess. All of the werewolves`' desks were a mess. Olaf had been with the company since the `'60s.
“double curved quotes”
‘single curved quotes’
Olaf’s desk was a mess.
All of the werewolves’ desks were a mess.
Olaf had been with the company since the ’60s.
3. Document Header
| A header is optional. |
| The header may not contain blank lines and must be offset from the content by at least one blank line. |
= My Document's Title My document provides...
= My Document's Title Doc Writer <doc.writer@asciidoctor.org> My document provides...
| Asciidoctor allows multiple authors in the author line. Use the semi-colon character to separate each author. |
= My Document's Title Doc Writer <doc.writer@asciidoctor.org> v1.0, 2014-01-01 My document provides...
| You cannot have a revision line without an author line. |
= My Document's Title Doc Writer <doc.writer@asciidoctor.org> v1.0, 2018-04-11 :toc: :imagesdir: assets/images :homepage: https://asciidoctor.org My document provides...
4. Section Titles (Headings)
= 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
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
| When using the article doctype (the default), you can only have one level-0 section title (i.e., the document title) and it must be in the document header. |
The number of equal signs matches the heading level in the HTML output.
For example, Section Level 1 becomes an <h2> heading.
|
= Document Title (Level 0) == Section Level 1 === Section Level 2 ==== Section Level 3 ===== Section Level 4 ====== Section Level 5 = Section Level 0
Document Title (Level 0)
Section Level 1
Section Level 2
Section Level 3
Section Level 4
Section Level 5
Section Level 0
[#primitives-nulls] == Primitive types and null values
sectanchors-
When this document attribute is set, a section icon anchor appears in front of the section title.
sectlinks-
When this document attribute is set, the section titles become self-links. This enables a reader to bookmark the section.
| Section title anchors depend on the default Asciidoctor stylesheet to render properly. |
5. Include Files
= Reference Documentation Lead Developer This is documentation for project X. include::basics.adoc[] include::installation.adoc[] include::example.adoc[]
| Asciidoctor does not insert blank lines between adjacent include statements to keep the content separated. Be sure to add a blank line in the source document to avoid unexpected results, such as a section title being swallowed. |
include::https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/README.adoc[]
Including content from a URI 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 Asciidoctor to read content from a URI.
|
6. Horizontal Rules and Page Breaks
'''
<<<
7. Lists
* Edgar Allen Poe * Sheri S. Tepper * Bill Bryson
-
Edgar Allen Poe
-
Sheri S. Tepper
-
Bill Bryson
- Edgar Allen Poe - Sheri S. Tepper - Bill Bryson
-
Edgar Allen Poe
-
Sheri S. Tepper
-
Bill Bryson
| A blank line is required before and after a list to separated it from other blocks. |
You can force two adjacent lists apart by inserting a blank line followed by a line comment after the first list.
The convention is to use //- as the line comment to provide a hint to other authors that it’s a list divider.
|
* level 1 ** level 2 *** level 3 **** level 4 ***** level 5 * level 1
-
level 1
-
level 2
-
level 3
-
level 4
-
level 5
-
-
-
-
-
level 1
| The unordered list marker can be changed using block styles. |
. Step 1 . Step 2 . Step 3
-
Step 1
-
Step 2
-
Step 3
| You can choose to include an ordinal in front of each list marker, but they have to be in sequence. |
. Step 1 . Step 2 .. Step 2a .. Step 2b . Step 3
-
Step 1
-
Step 2
-
Step 2a
-
Step 2b
-
-
Step 3
. level 1 .. level 2 ... level 3 .... level 4 ..... level 5 . level 1
-
level 1
-
level 2
-
level 3
-
level 4
-
level 5
-
-
-
-
-
level 1
For ordered lists, Asciidoctor supports numeration styles such as lowergreek and decimal-leading-zero.
|
* [*] checked * [x] also checked * [ ] not checked * normal list item
-
checked
-
also checked
-
not checked
-
normal list item
| Checklists can use font-based icons and be interactive. |
first term:: definition of first term second term:: definition of second term
- first term
-
definition of first term
- second term
-
definition of second term
first term:: definition of first term second term:: definition of second term
- first term
-
definition of first term
- second term
-
definition of second term
[qanda] What is Asciidoctor?:: An implementation of the AsciiDoc processor in Ruby. What is the answer to the Ultimate Question?:: 42
-
What is Asciidoctor?
An implementation of the AsciiDoc processor in Ruby.
-
What is the answer to the Ultimate Question?
42
Operating Systems::
Linux:::
. Fedora
* Desktop
. Ubuntu
* Desktop
* Server
BSD:::
. FreeBSD
. NetBSD
Cloud Providers::
PaaS:::
. OpenShift
. CloudBees
IaaS:::
. Amazon EC2
- Operating Systems
-
- Linux
-
-
Fedora
-
Desktop
-
-
Ubuntu
-
Desktop
-
Server
-
-
- BSD
-
-
FreeBSD
-
NetBSD
-
- Cloud Providers
-
- PaaS
-
-
OpenShift
-
CloudBees
-
- IaaS
-
-
Amazon EC2
-
| 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.
$ gem install asciidoctor
* AsciiDoc lists may contain any complex content.
+
[cols="2", options="header"]
|===
|Application
|Language
|AsciiDoc
|Python
|Asciidoctor
|Ruby
|===
-
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.
$ gem install asciidoctor
-
AsciiDoc lists may contain any complex content.
Application Language AsciiDoc
Python
Asciidoctor
Ruby
8. Links
https://asciidoctor.org - automatic! https://asciidoctor.org[Asciidoctor] https://github.com/asciidoctor[Asciidoctor @ *GitHub*]
link:++https://example.org/?q=[a b]++[URL with special characters] link:https://example.org/?q=%5Ba%20b%5D[URL with special characters]
link:\\server\share\whitepaper.pdf[Whitepaper]
link:index.html[Docs]
devel@discuss.arquillian.org mailto:devel@discuss.arquillian.org[Discuss Arquillian] mailto:devel-join@discuss.arquillian.org[Subscribe, Subscribe me, I want to join!] irc://irc.freenode.org/#fedora
http://discuss.asciidoctor.org[Discuss Asciidoctor, role="external", window="_blank"] http://discuss.asciidoctor.org[Discuss Asciidoctor^] https://example.org["Google, Yahoo, Bing^", role="teal"]
Links with attributes (including the subject and body segments on mailto links) are a feature unique to Asciidoctor.
To enable them, you must set the linkattrs attribute on the document.
When they are enabled, you must quote the link text if it contains a comma.
|
[[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>>.
See Paragraphs to learn how to write paragraphs.
Learn how to organize the document into sections.
Refer to <<document-b.adoc#section-b,Section B>> for more information. See you when you get back from <<document-b#section-b,Section B>>!
9. Images
Images are resolved relative to the value of the imagesdir document attribute, which is empty by default.
You are encouraged to make use of the imagesdir attribute to avoid hard-coding the common path to your images in every image macro.
The imagesdir attribute can be an absolute path, relative path, or base URL.
When the image target is a URL or absolute path, the imagesdir prefix is not prepended.
image::sunset.jpg[]
.A mountain sunset [#img-sunset] [caption="Figure 1: ",link=https://www.flickr.com/photos/javh/5448336655] image::sunset.jpg[Sunset,300,200] image::https://asciidoctor.org/images/octocat.jpg[GitHub mascot]
Click image:play.png[Play, title="Play"] to get the party started. Click image:pause.png[title="Pause"] when you need a break.
Click 
to get the party started.
Click 
when you need a break.
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.
|
image:sunset.jpg[Sunset,150,150,role="right"] What a beautiful sunset!
What a beautiful sunset!
| There are a variety of attributes available to position and frame images. |
= 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.
|
Instead of declaring the data-uri attribute in the document, you can pass it as a command-line argument using -a data-uri.
|
10. Videos
video::video_file.mp4[] video::video_file.mp4[width=640, start=60, end=140, options=autoplay]
video::rPQoq7ThGAU[youtube]
video::67480300[vimeo]
| You can control the video settings using additional attributes and options on the macro. |
11. Source Code
Reference code like `types` or `methods` inline.
Reference code like types or methods inline.
Output literal monospace text such as `+{backtick}+` by
enclosing the text in pluses, then again in backticks.
Output literal monospace text such as {backtick} by
enclosing the text in pluses, then again in backticks.
Indent the line one space to insert a code snippet
Indent the line one space to insert a code snippet
.... error: The requested operation returned error: 1954 Forbidden search for defensive operations manual absolutely fatal: operation initiation lost in the dodecahedron of doom would you like to die again? y/n ....
error: The requested operation returned error: 1954 Forbidden search for defensive operations manual absolutely fatal: operation initiation lost in the dodecahedron of doom would you like to die again? y/n
.Gemfile.lock
----
GEM
remote: https://rubygems.org/
specs:
asciidoctor (1.5.6.1)
PLATFORMS
ruby
DEPENDENCIES
asciidoctor (~> 1.5.6.1)
----
GEM
remote: https://rubygems.org/
specs:
asciidoctor (1.5.6.1)
PLATFORMS
ruby
DEPENDENCIES
asciidoctor (~> 1.5.6.1)
.app.rb [source,ruby] ---- require 'sinatra' get '/hi' do "Hello World!" end ----
require 'sinatra'
get '/hi' do
"Hello World!"
end[source,ruby] ---- require 'sinatra' // <1> get '/hi' do // <2> "Hello World!" // <3> end ---- <1> Library import <2> URL mapping <3> HTTP response body
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> ---- <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.
line of code (1) line of code (2) line of code (3)
| 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. |
[source,xml] ---- <section> <title>Section Title</title> <!--1--> </section> ---- <1> The section title is required.
<section>
<title>Section Title</title> (1)
</section>| 1 | The section title is required. |
[source,ruby] ---- include::app.rb[] ----
:sourcedir: src/main/java
[source,java]
----
include::{sourcedir}/org/asciidoctor/Asciidoctor.java[]
----
[source,ruby,indent=0] ---- include::lib/document.rb[lines=5..10] ----
|
[source,xml] <meta name="viewport" content="width=device-width, initial-scale=1.0"> This is normal content.
<meta name="viewport"
content="width=device-width, initial-scale=1.0">This is normal content.
|
Enabling the syntax highlighter
Syntax highlighting is enabled by setting the :source-highlighter: pygments The valid options are |
12. More Delimited Blocks
.AsciiDoc history **** AsciiDoc was first released in Nov 2002 by Stuart Rackham. It was designed from the start to be a shorthand syntax for producing professional documents like DocBook and LaTeX. ****
| Any block can have a title, positioned above the block. A block title is a line of text that starts with a dot. The dot cannot be followed by a space. |
.Sample document ==== Here's a sample AsciiDoc document: [listing] .... = Title of Document Doc Writer :toc: This guide provides... .... The document header is useful, but not required. ====
Here’s a sample AsciiDoc document:
= Title of Document Doc Writer :toc: This guide provides...
The document header is useful, but not required.
[NOTE] ==== An admonition block may contain complex content. .A list - one - two - three Another paragraph. ====
|
An admonition block may contain complex content. A list
Another paragraph. |
|
Admonition and callout icons
Asciidoctor can “draw” icons using Font Awesome and CSS. To use this feature, set the value of the |
[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 http://en.wikipedia.org/wiki/Lewis_Carroll[Lewis Carroll]'] ____ If you don't know where you are going, any road will get you there. ____
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." -- Thomas Jefferson, Papers of Thomas Jefferson: Volume 11
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
[, James Baldwin] "" Not everything that is faced can be changed. But nothing can be changed until it is faced. ""
"" Not everything that is faced can be changed. But nothing can be changed until it is faced. ""
++++ <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> ++++
Content in a passthrough block is passed to the output unprocessed. That means you can include raw HTML, like this embedded Gist:
-- An open block can be an anonymous container, or it can masquerade as any other block. -- [source] -- puts "I'm a source block!" --
An open block can be an anonymous container, or it can masquerade as any other block.
puts "I'm a source block!":version: 1.5.6.1
[source,xml,subs="verbatim,attributes"]
----
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-java-integration</artifactId>
<version>{version}</version>
</dependency>
----
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-java-integration</artifactId>
<version>1.5.6.1</version>
</dependency>13. Block Id, Role and Options
[[goals]] [role="incremental"] * Goal 1 * Goal 2
[#goals.incremental] * Goal 1 * Goal 2
|
[[free_the_world]][big goal]_free the world_
[#free_the_world.big.goal]_free the world_
[.rolename]`monospace text`
[options="header,footer,autowidth"] |=== |Cell A |Cell B |===
[%header%footer%autowidth] |=== |Cell A |Cell B |===
14. Comments
// A single-line comment.
| Single-line comments can be used to divide elements, such as two adjacent lists. |
//// A multi-line comment. Notice it's a delimited block. ////
15. Tables
.Table Title |=== |Name of Column 1 |Name of Column 2 |Name of Column 3 (1) (2) |Cell in column 1, row 1 |Cell in column 2, row 1 |Cell in column 3, row 1 |Cell in column 1, row 2 |Cell in column 2, row 2 |Cell in column 3, row 2 |===
| Name of Column 1 | Name of Column 2 | Name of Column 3 |
|---|---|---|
Cell in column 1, row 1 |
Cell in column 2, row 1 |
Cell in column 3, row 1 |
Cell in column 1, row 2 |
Cell in column 2, row 2 |
Cell in column 3, row 2 |
| 1 | Unless the cols attribute is specified, the number of columns is equal to the number of cell separator characters on the first (non-blank) line between the block delimiters. |
| 2 | When a blank line follows the first non-blank line, the cell in the first line get promoted to the table header. |
[%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 |===
| 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 of 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. |
[cols="1,1,2", options="header"] (1) .Applications |=== |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. |===
| 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. |
[cols="2,2,5a"] |=== |Firefox |Browser |Mozilla Firefox is an open-source web browser. It's designed for: * standards compliance * performance * portability http://getfirefox.com[Get Firefox]! |===
Firefox |
Browser |
Mozilla Firefox is an open-source web browser. It’s designed for:
|
[%header,format=csv] |=== Artist,Track,Genre Baauer,Harlem Shake,Hip Hop The Lumineers,Ho Hey,Folk Rock |===
| Artist | Track | Genre |
|---|---|---|
Baauer |
Harlem Shake |
Hip Hop |
The Lumineers |
Ho Hey |
Folk Rock |
,=== Artist,Track,Genre Baauer,Harlem Shake,Hip Hop ,===
| Artist | Track | Genre |
|---|---|---|
Baauer |
Harlem Shake |
Hip Hop |
|=== include::customers.csv[] |===
:=== Artist:Track:Genre Robyn:Indestructable:Dance :===
| Artist | Track | Genre |
|---|---|---|
Robyn |
Indestructable |
Dance |
[cols="e,m,^,>s", width="25%"] |=== |1 >s|2 |3 |4 ^|5 2.2+^.^|6 .3+<.>m|7 ^|8 |9 2+>|10 |===
1 |
2 |
3 |
4 |
5 |
|
|
|
8 |
|||
9 |
|
||
16. UI 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 |kbd:[Ctrl+Shift+N] |New incognito window |kbd:[\ ] |Used to escape characters |kbd:[Ctrl+\]] |Jump to keyword |kbd:[Ctrl + +] |Increase zoom |===
| Shortcut | Purpose |
|---|---|
F11 |
Toggle fullscreen |
Ctrl+T |
Open a new tab |
Ctrl+Shift+N |
New incognito window |
\ |
Used to escape characters |
Ctrl+] |
Jump to keyword |
Ctrl++ |
Increase zoom |
To save the file, select menu:File[Save]. Select menu:View[Zoom > Reset] to reset the zoom level to the default setting.
To save the file, select .
Select to reset the zoom level to the default setting.
Press the btn:[OK] button when you are finished. Select a file in the file navigator and click btn:[Open].
Press the OK button when you are finished.
Select a file in the file navigator and click Open.
17. Attributes and Substitutions
:url-home: https://asciidoctor.org
:link-docs: https://asciidoctor.org/docs[documentation]
:summary: Asciidoctor 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!
Check out Asciidoctor! Asciidoctor 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! |
-
Attribute passed to the API or CLI that does not end in
@ -
Attribute defined in the document
-
Attribute passed to the API or CLI that ends in
@ -
Intrinsic attribute value (default values)
To make an attribute value that is passed to the API or CLI have a lower precedence than an assignment in the document, add an @ symbol to the end of the attribute value.
|
| Attribute name | Replacement text | Appearance |
|---|---|---|
|
nothing |
|
|
nothing |
|
|
single space |
|
|
  |
|
|
​ |
|
|
⁠ |
|
|
' |
' |
|
" |
" |
|
‘ |
‘ |
|
’ |
’ |
|
“ |
“ |
|
” |
” |
|
° |
° |
|
+ |
+ |
|
¦ |
¦ |
|
| |
| |
|
& |
& |
|
< |
< |
|
> |
> |
|
[ |
[ |
|
] |
] |
|
^ |
^ |
|
* |
* |
|
~ |
~ |
|
\ |
\ |
|
` |
` |
|
:: |
:: |
|
;; |
;; |
|
C++ |
C++ |
[1] Some replacements are Unicode characters, whereas others are numeric character references (e.g., "). These character references are used whenever the use of the Unicode character could interfere with the AsciiDoc syntax or confuse the renderer (i.e., the browser). It’s up to the converter to transform the reference into something the renderer understands (something both the man page and PDF converter handle).
[2] Asciidoctor does not prevent you from reassigning predefined attributes. However, it’s best to treat them as read-only unless the output format requires the use of a different encoding scheme. These attributes are an effective tool for decoupling content and presentation.
[3] Asciidoctor allows you to use any of the named character references (aka named entities) defined in HTML (e.g., € resolves to €). However, using named character references can cause problems when generating non-HTML output such as PDF because the lookup table needed to resolve these names may not be defined. Our recommendation is avoid using named character references—with the exception of those defined in XML (i.e., lt, gt, amp, quot and apos). Instead, use numeric character references (e.g., €).
[4] The Zero Width Space (ZWSP) is a code point in Unicode that shows where a long word can be split if necessary.
[5] The word joiner (WJ) is a code point in Unicode that prevents a line break at its position.
| Attribute | Description | Example Value |
|---|---|---|
|
Set if the current processor is Asciidoctor. |
|
|
Asciidoctor version. |
|
|
Backend used to create the output file. |
|
|
The backend value minus any trailing numbers.
For example, if the backend is |
|
|
|
|
|
|
|
|
Full path of the directory that contains the source document. |
|
|
Full path of the source document. |
|
|
File extension of the source document, including the leading period. Introduced in 1.5.6. |
|
|
Root name of the source document (no leading path or file extension). |
|
|
|
|
|
Document type (article, book or manpage). |
|
|
Year that the document was last modified.[1,2] |
|
|
Set if content is being converted to an embeddable document (body only). |
|
|
File extension of the output file name (without leading period). |
|
|
Syntax used when generating the HTML output (html or xhtml). |
|
|
Date when the document was converted.[2] |
|
|
Date and time when the document was converted.[2] |
|
|
Time when the document was converted.[2] |
|
|
Year when the document was converted.[2] |
|
|
Full path of the output directory. |
|
|
Full path of the output file. |
|
|
File extension of the output file (starting with a period) as determined by the backend ( |
|
|
Numeric value of the safe mode setting. (UNSAFE=0, SAFE=10, SERVER=10, SECURE=20). |
|
|
Textual value of the safe mode setting. |
|
|
Set if the safe mode is UNSAFE. |
|
|
Set if the safe mode is SAFE. |
|
|
Set if the safe mode is SERVER. |
|
|
Set if the safe mode is SECURE. |
|
|
Home directory of the current user.
Resolves to |
|
[1] Only reflects the last modified time of the source document file. It does not consider the last modified time of files which are included.
[2] If the SOURCE_DATE_EPOCH environment variable is set, the value assigned to this attribute is built from a UTC date object that corresponds to the timestamp (as an integer) stored in that environment variable. This override offers one way to make the conversion reproducible. See https://reproducible-builds.org/specs/source-date-epoch/ for more information about the SOURCE_DATE_EPOCH environment variable.
none
|
Disables substitutions |
normal
|
Performs all substitutions except for callouts |
verbatim
|
Replaces special characters and processes callouts |
specialchars, specialcharacters
|
Replaces |
quotes
|
Applies text formatting |
attributes
|
Replaces attribute references |
replacements
|
Substitutes textual and character reference replacements |
macros
|
Processes macros |
post_replacements
|
Replaces the line break character ( |
[caption=""]
.Parts{counter2:index:0}
|===
|Part Id |Description
|PX-{counter:index}
|Description of PX-{index}
|PX-{counter:index}
|Description of PX-{index}
|===
| Part Id | Description |
|---|---|
PX-1 |
Description of PX-1 |
PX-2 |
Description of PX-2 |
18. Text Replacement
| 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., |
ellipses |
... |
… |
… |
|
right single arrow |
-> |
→ |
→ |
|
right double arrow |
=> |
⇒ |
⇒ |
|
left single arrow |
<- |
← |
← |
|
left double arrow |
<= |
⇐ |
⇐ |
|
apostrophe |
Sam's |
Sam’s |
Sam’s |
The vertical form apostrophe is replaced with the curved form apostrophe. |
| Any named, numeric or hex XML entity reference is supported. |
19. Escaping Text
\*Stars* is not rendered as bold text.
The asterisks around the word are preserved.
\{author} is not resolved to the author name.
The curly brackets around the word are preserved.
`A\--Z` connects A to Z in monospace using two dashes.
The dashes are not replaced by an em dash.
\[[Word]] is not interpreted as an anchor.
The double brackets around the word are preserved.
[\[[Word]]] is not interpreted as a bibliography anchor.
The triple brackets around the word are preserved.
In these cases, the backslash character is automatically removed.
*Stars* is not rendered as bold text. The asterisks around the word are preserved.
{author} is not resolved to the author name. The curly brackets around the word are preserved.
A--Z connects A to Z in monospace using two dashes.
The dashes are not replaced by an em dash.
[[Word]] is not interpreted as an anchor. The double brackets around the word are preserved.
[[[Word]]] is not interpreted as a bibliography anchor. The triple brackets around the word are preserved.
In these cases, the backslash character is automatically removed.
`+Text inside {plus} characters+` is not formatted.
However, special characters like +<+ and +>+ are still escaped.
Text inside {plus} characters is not formatted.
However, special characters like < and > are still escaped.
+++<u>underline me</u>+++ is underlined. pass:[<u>underline me</u>] is also underlined.
underline me is underlined.
underline me is also underlined.
20. Table of Contents (ToC)
= AsciiDoc Writer's Guide Doc Writer <doc.writer@asciidoctor.org> v1.0, 2013-08-01 :toc:
= AsciiDoc Writer's Guide Doc Writer <doc.writer@asciidoctor.org> v1.0, 2014-08-01 :toc: right
| The ToC title, levels, and positioning can be customized. |
21. 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,2]]] Erich Gamma, Richard Helm, Ralph Johnson & John Vlissides. Design Patterns: Elements of Reusable Object-Oriented Software. Addison-Wesley. 1994.
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” [2]. |
22. Footnotes
A statement.footnote:[Clarification about this statement.] A bold statement!footnote:disclaimer[Opinions are my own.] Another bold statement.footnote:disclaimer[]
23. Markdown Compatibility
Markdown compatible syntax is only available when using Asciidoctor.
# Document Title (Level 0) ## Section Level 1 ### Section Level 2 #### Section Level 3 ##### Section Level 4 ###### Section Level 5
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 ```
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 11
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.
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.
--- - - - *** * * *
24. User Manual and Help
To learn more about Asciidoctor and its capabilities, check out the other Asciidoctor guides and its User Manual. Also, don’t forget to join the Asciidoctor mailing list, where you can ask questions and leave comments.