AsciiDoc Quick Reference Guide

AsciiDoc is a plain text markup language designed for creating technical content. AsciiDoc is feature rich with semantic elements and built to be modular with content reusability. AsciiDoc can be read as is or converted in to multiple formats including html, pdf, e-books, man pages, slide presentation and many more.

The Eclipse Foundation maintains the AsciiDoc project. The full AssciiDoc Specification is found here

Text Formatting

Example 1. Bold

*constrained*
**un**constrained

Example 2. Italics

_constrained_
__un__constrained

Example 3. Bold Italics

*_constrained_*
**__un__**constrained

Example 4. Monospace

`constrained`
``un``constrained

Example 5. Monospace Bold

`constrained`
``**un**``constrained

Example 6. Monospace Italic

`_constrained_`
``__un__``constrained

Example 7. Monospace Bold Italic

`*_constrained_*`
``**__un__**``constrained

Example 8. Underlined

[.underline]#Underlined#

Example 9. Strike-Through

[.line-through]#Strike-Through#

Example 10. Highlighted

#constrained#
##Un##constrained

Example 11. ^SuperScript

^Super^Script

Example 12. _subScript

~sub~Script

Section Titles and Levels

= Document Title - Level 0

== Section Title - Level 1

=== Section Title - Level 2

==== Section Title - Level 3

===== Section Title - Level 4

====== Section Title - Level 5

== Section Title - Level 1

Paragraph

Create a paragraph by leaving a blank line between the text.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

    Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum

Lists

Ordered Lists

. One
. Two
.. Two a
. Three
.. Three a
... Three a i
.. Three b
. Four

One
Two
1. Two a
Three
1. Three a
  1. Three a i
2. Three b
Four

Unordered Lists

* Point 1
** sub Point 1
* Point 2
** sub Point 2
*** sub sub Point 2
* Point 3

Point 1
- sub Point 1
Point 2
- sub Point 2
  - sub sub Point 2
Point 3

Description Lists

Item 1:: Offset text
Item 1A::: Offest text

[horizontal]
Item 2:: Inline text
Item 2a::: Offset text
Item 2ai:::: Offset text
Item 2b::: offset text
Item 3:: Inline text

Item 1

Offset text

Item 1A: Offset text

Item 2	Inline text Item 2a Offset text Item 2ai Offset text Item 2b offset text
Item 3	Inline text

Mixed Lists

Topic::
Section 1:::
. One
. Two
* Two A
** Two A
Section 2:::
. One
.. One A
. Two
.. Two A
* Two AI

Topic

Section 1

One
Two
- Two A
  - Two AI
Three

Section 2

One
1. One A
Two
1. Two A
  - Two AI

Task

* [*] Task 1
* [x] Task 2
* [ ] Task 3

Task 1
Task 2
Task 3

Links

Web

https://documentation.cafe - Documentation Cafe

https://documentation.cafe[Documentation Cafe]

https://documentation.cafe[info@documentation.cafe]

https://documentation.cafe - Documentation Cafe

Documentation Cafe

info@documentation.cafe

Video

Example 13. Embedded Local

video::local-video-file.mp4[]

video::loccal-video-file.mp4[width=640,start=60,opts=autoplay]

Example 14. Embedded YouTube

video::jfKfPfyJRdk[youtube]

Example 15. Embedded Vimeo

video::jfKfPfyJRdk[vinmeo]

Audio

audio::local-file.wav[]

audio::local file.wav[start=60,opts=autoplay]

Relative

link:markdown.adoc[Markdown Guide]

xref:../../drinks/pages/frech-press.adoc[French Press Recipe]

Markdown Guide

French Press Recipe

Inline Anchors

[[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 xref label attribute will be used as link text in the cross-reference link.

Inline anchors make arbitrary content referenceable.

Inline anchors can be applied to a phrase such as this one.

Use a cross-reference to link to this location.

The xreflabel attribute is used as link text in the cross-reference link.

Internal Reference to Sections & Anchors

Go to the <<Lists>> section to learn more about lists

To more about <<Text Formating, formating here>>

Link to <<bookmark-a, bookmark-a>> anchor

Go to the Lists section to learn more about lists

To learn more about formatting here

Link to bookmark-a anchor

Include Text from another File

  include::../examples/include.adoc[]

  include::../examples/include-with-tags.adoc[tags=tagName]

This is text from another file

This is text from another file by using tags

Code Block

  [source,javascript]
  ----
  var http = require('http');

  http.createServer(function (req, res) {
    res.writeHead(200, {'Content-Type': 'text/plain'});
    res.end('Hello World!');
  }).listen(8080);
  ----

var http = require('http');

http.createServer(function (req, res) {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('Hello World!');
}).listen(8080);

Tables

.Table1 Title
|===
|Column 1 |Column 2 |Column 3
|Cell,Column1,Row1 |Cell,Column3,Row1 |Cell,Column3,Row1
|Cell,Column1,Row2 |Cell,Column3,Row2 |Cell,Column3,Row2
|Cell,Column1,Row3 |Cell,Column3,Row3 |
|===

.Table2 Title
|===
|Column 1 |Column 2 |Column 3
|Cell,Column1,Row1
|Cell,Column3,Row1
|Cell,Column3,Row1
|Cell,Column1,Row2
|Cell,Column3,Row2
|
|===

Table 1. Table1 Title
Column 1	Column 2	Column 3
Cell,Column1,Row1	Cell,Column3,Row1	Cell,Column3,Row1
Cell,Column1,Row2	Cell,Column3,Row2	Cell,Column3,Row2
Cell,Column1,Row3	Cell,Column3,Row3

Table 2. Table2 Title
Column 1	Column 2	Column 3
Cell,Column1,Row1	Cell,Column3,Row1	Cell,Column3,Row1
Cell,Column1,Row2	Cell,Column3,Row2

Admonitions

Example 16. Basic Admonitions

NOTE: Please note these notes

TIP: Turning it off and on does fix a lot of issues

IMPORTANT: Don't forget to brush your teeth

WARNING: Watch out for jackalopes

CAUTION: Danger Will Robinson!

Please note these notes

Turning it off and on does fix many issues

Don’t forget to brush your teeth

Watch out for jackalopes

Danger Will Robinson!

Example 17. Titled Admonitions

[WARNING]
.Quicksand
====
As we learned as childeren quicksand can be lurking around every corner!
====

Quicksand Warning

As we learned as children quicksand can be lurking around every corner!

Example 18. Table of Contents shows in the default position, immediately below the document title

= AsciiDoc Quick Reference Guide
:toc:

Example 19. Table of Contents shows on the right

= AsciiDoc Quick Reference Guide

Example 20. Table of Contents shows on the left

= AsciiDoc Quick Reference Guide
:toc: left