AsciiDoc Quick Reference
========================
Stuart Rackham

AsciiDoc Quick Reference
------------------------

Text Formatting
~~~~~~~~~~~~~~~
``_
[separator="|"]
AsciiDoc Example |Rendered Result
___
`\\'emphasized' text`|'emphasized' text
`\\*strong* text`|*strong* text
`\\`monospaced\\` text`|`monospaced` text
`show \\\\'single quotes`|show \\'single quotes'
___

.NOTES:
- Use backslash escape to inhibit formatting.

URLs
~~~~
``_
[separator="|"]
AsciiDoc Example |Rendered Result
___
`\http://www.python.org[]`|http://www.python.org[]
`\http://www.python.org[Python website]`|http://www.python.org[Python website]
`\mailto:support@foobar.org[]`|mailto:support@foobar.org[]
`\\ftp://ftp.python.org/pub/python[]`|ftp://ftp.python.org/pub/python[]
`\\ftp://ftp.python.org/pub/python[Python downloads]`|ftp://ftp.python.org/pub/python[Python downloads]
___

.NOTES:
- Use backslash escape to suppress macro expansion.

Document Links
~~~~~~~~~~~~~~
TODO

Lists
~~~~~
AsciiDoc examples
^^^^^^^^^^^^^^^^^
.........................................
Ordered list:

1. Ordered list item 1
   leading text
   a. Nested list item 1
   b. Nested list item 2

2. Ordered list item 2
   leading text.

Simple list:

-  Simple list item 1
   * Nested list item 1
   * Nested list item 2
-  Simple list item 2

Variable list:

Variable list term 1::
    List definition paragraph.
Variable list term 2::
    List definition paragraph.
    * Nested list item 1
    * Nested list item 2
.........................................

Rendered results
^^^^^^^^^^^^^^^^
Ordered list:

1. Ordered list item 1
   leading text
   a. Nested list item 1
   b. Nested list item 2

2. Ordered list item 2
   leading text.

Simple list:

-  Simple list item 1
   * Nested list item 1
   * Nested list item 2
-  Simple list item 2

Variable list:

Variable list term 1::
    List definition paragraph.
Variable list term 2::
    List definition paragraph.
    * Nested list item 1
    * Nested list item 2


Images
~~~~~~
TODO

Callouts
~~~~~~~~
AsciiDoc Example
^^^^^^^^^^^^^^^^
.....................................................................
  .Callouts example
  --------------------------------------
  #include <stdio.h>                 \<1>

  int main() {                       \<2>
          printf("Hello World!\n");
          exit(0);                   \<3>\<4>
  }
  --------------------------------------
  \<1> Include `stdio.h` header file.
  \<2> Program entry point.
  \<3> Exit program.
  \<4> Progam exit code zero signals the program ran to completion without
      any errors.
.....................................................................

Rendered Result
^^^^^^^^^^^^^^^
.Callouts example
--------------------------------------
#include <stdio.h>                 <1>

int main() {                       <2>
	printf("Hello World!\n");
	exit(0);                   <3><4>
}
--------------------------------------
<1> Include `stdio.h` header file.
<2> Program entry point.
<3> Exit program.
<4> Progam exit code zero signals the program ran to completion without
    any errors.


Admonitions
~~~~~~~~~~~
TODO

Index Entries
~~~~~~~~~~~~~
TODO

Footnotes
~~~~~~~~~
TODO

/////////////////////////////////////////////////////////

||Example              |Result            |Description   |
|`\\'emphasized' text` |'emphasized' text |Single quotes.|

/////////////////////////////////////////////////////////
