AsciiDoc(tor): Yo Dawg!

1. Intro

Okay, let’s do it.

Test

// include::{home}/.cache/wal/colors-wal-st.h[]

2. Lists

2.1. Unordered lists

* level 1
** level 2
*** level 3
**** level 4
***** level 5
* level 1

Example 1. Output

level 1
- level 2
  - level 3
    
    level 4
    
    level 5
level 1

2.2. Ordered lists

. level 1
.. level 2
... level 3
.... level 4
..... level 5
. level 1

Example 2. Output

level 1
1. level 2
  1. level 3
    
    level 4
    
    level 5
level 1

2.3. TODO lists

- [*] checked
- [x] also checked
- [ ] not checked
- normal list item

Example 3. Output

✓ checked
✓ also checked
❏ not checked
normal list item

2.4. Separating lists

. Apples
. Oranges

//-

. Walnuts
. Almonds

Example 4. Output

Apples
Oranges

Walnuts
Almonds

3. Definitions

3.1. Normal definition list

first term:: definition of first term
section term:: definition of second term

Example 5. Output

first term: definition of first term
section term: definition of second term

3.2. Horizontal definition list

[horizontal]
first term:: definition of first term
section term:: definition of second term

Example 6. Output

first term	definition of first term
section term	definition of second term

3.3. Multi-line definition list

first term::
definition of first term
section term::
definition of second term

Example 7. Output

first term: definition of first term
section term: definition of second term

3.4. Q&A

[qanda]
What is Asciidoctor?::
An implementation of the AsciiDoc processor in Ruby.
What is the answer to the Ultimate Question?:: 42

Example 8. Output

What is Asciidoctor?

An implementation of the AsciiDoc processor in Ruby.
What is the answer to the Ultimate Question?

42

3.5. Mixed

Operating Systems::
    Linux:::
        . Fedora
            * Desktop
        . Ubuntu
            * Desktop
            * Server
    BSD:::
        . FreeBSD
        . NetBSD
Cloud Providers::
    PaaS:::
        . OpenShift
        . CloudBees
    IaaS:::
        . Amazon EC2
        . Rackspace

Example 9. Output

Operating Systems

Linux

Fedora
- Desktop
Ubuntu
- Desktop
- Server

BSD

FreeBSD
NetBSD

Cloud Providers

PaaS

OpenShift
CloudBees

IaaS

Amazon EC2
Rackspace

Note	Note that the indentation is optional

3.6. Complex content in outline lists

* 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
|===

Example 10. Output

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

Application	Language
AsciiDoc	Python
Asciidoctor	Ruby

4. Links

4.1. External

http://asciidoctor.org - automatic!

http://asciidoctor.org[Asciidoctor]

https://github.com/asciidoctor[Asciidoctor @ *GitHub*]

Example 11. Output

http://asciidoctor.org - automatic!

Asciidoctor

Asciidoctor @ GitHub

4.2. Relative

link:test.adoc[Docs]

Example 12. Output

Docs

4.3. Email and IRC

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/#asciidoctor

Example 13. Output

devel@discuss.arquillian.org

Discuss Arquillian

Subscribe

irc://irc.freenode.org/#asciidoctor

4.4. Inline anchors

[[bookmark-a]]Inline anchors make arbitrary content referenceable.

anchor:bookmark-b[]Use a cross reference to link to this location.

Example 14. Output

Inline anchors make arbitrary content referenceable.

Use a cross reference to link to this location.

4.5. Internal cross references

See <<paragraphs>> to learn how to write paragraphs.

Learn how to organize the document into <<section-titles,sections>>.

Example 15. Output

See [paragraphs] to learn how to write paragraphs.

Learn how to organize the document into sections.

4.6. Images

image::/images/asciidoc/rose.png[]

image::/images/asciidoc/rose.png[Rose]

[[img-sunset]]

image::/images/asciidoc/rose.png[caption="Figure 1: ", title="A rose", alt="Rose", width="300", height="200", link="http://www.flickr.com/photos/javh/5448336655"]

image::http://asciidoctor.org/images/octocat.jpg[GitHub mascot]

Example 16. Output

Figure 1: A rose

5. Admonition paragraph

5.1. NOTE

NOTE: This is a NOTE!

Example 17. Output

Note	This is a NOTE!

5.2. TIP

TIP: This is a TIP!

Example 18. Output

Tip	This is a TIP!

5.3. WARNING

WARNING: This is a WARNING!

Example 19. Output

Warning

This is a WARNING!

5.4. CAUTION

CAUTION: This is a CAUTION!

Example 20. Output

Caution

This is a CAUTION!

5.5. IMPORTANT

IMPORTANT: This is a IMPORTANT!

Example 21. Output

Important

This is a IMPORTANT!

5.6. Admonition blocks

[NOTE]
====
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:

* NOTE
* TIP
* WARNING
* CAUTION
* IMPORTANT
====

Example 22. Output

Note	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: NOTE TIP WARNING CAUTION IMPORTANT

6. Blocks

6.1. Listing block

-----
This is a **_listing block_**
-----

Example 23. Output

This is a **_listing block_**

6.2. Example block

=====
This is a **_example block_**
=====

Example 24. Output

This is a example block

6.3. Comment block

////
This is a **_comment block_**
////

Example 25. Output

6.4. Literal block

....
This is a **_literal block_**
....

Example 26. Output

This is a **_literal block_**

6.5. Pass block

++++
== This is raw text
++++

Example 27. Output

== This is raw text

6.6. Quote/Verse block

____
This is a very very simple quote
____

Example 28. Output

This is a very very simple quote

6.6.1. blockqoutes

.After landing the cloaked Klingon bird of prey in Golden Gate park:
[quote,Captain James T. Kirk,Star Trek IV: The Voyage Home]
Everybody remember where we parked.

Example 29. Output

After landing the cloaked Klingon bird of prey in Golden Gate park:

Everybody remember where we parked.

— Captain James T. Kirk
Star Trek IV: The Voyage Home

6.7. Sidebar block

.Some Title
****
This is a Sidebar block -- I have no idea why it's called `sidebar`
****

Example 30. Output

Some Title

This is a Sidebar block — I have no idea why it’s called sidebar

6.8. Block metadata

.Gettysburg Address
[[gettysburg]]
[quote, Abraham Lincoln, Soldiers' National Cemetery Dedication]
----
Four score and seven years ago our fathers brought forth
on this continent a new nation...
Now we are engaged in a great civil war, testing whether
that nation, or any nation so conceived and so dedicated,
can long endure. ...
----

Example 31. Output

Gettysburg Address

Four score and seven years ago our fathers brought forth
on this continent a new nation...
Now we are engaged in a great civil war, testing whether
that nation, or any nation so conceived and so dedicated,
can long endure. ...