2016-01-14 04:50:24 +00:00
---
language: asciidoc
contributors:
2016-01-26 08:32:28 +00:00
- ["Ryan Mavilia", "http://unoriginality.rocks/"]
2017-09-11 17:16:13 +00:00
- ["Abel Salgado Romero", "https://twitter.com/abelsromero"]
2016-01-14 04:50:24 +00:00
filename: asciidoc.md
---
AsciiDoc is a markup language similar to Markdown and it can be used for anything from books to blogs. Created in 2002 by Stuart Rackham the language is simple but it allows for a great amount of customization.
Document Header
Headers are optional and can't contain blank lines. It must be offset from content by at least one blank line.
Title Only
2016-02-15 06:47:19 +00:00
```
2016-01-14 04:50:24 +00:00
= Document Title
First sentence of document.
```
Title and Author
2016-02-15 06:47:19 +00:00
```
2016-01-14 04:50:24 +00:00
= Document Title
First Last < first.last @ learnxinyminutes . com >
Start of this document.
```
Multiple Authors
2016-02-15 06:47:19 +00:00
```
2016-01-14 04:50:24 +00:00
= Document Title
John Doe < john @ go . com > ; Jane Doe< jane @ yo . com > ; Black Beard < beardy @ pirate . com >
Start of a doc with multiple authors.
```
Revision Line (requires an author line)
2016-02-15 06:47:19 +00:00
```
2016-01-14 04:50:24 +00:00
= Doc Title V1
Potato Man < chip @ crunchy . com >
v1.0, 2016-01-13
This article about chips is going to be fun.
```
2016-02-15 06:47:19 +00:00
2016-01-26 08:27:17 +00:00
Paragraphs
2016-02-15 06:47:19 +00:00
```
2016-01-26 08:27:17 +00:00
You don't need anything special for paragraphs.
2016-02-17 13:36:47 +00:00
Add a blank line between paragraphs to separate them.
2016-01-26 08:27:17 +00:00
To create a line blank add a +
2016-02-17 13:36:47 +00:00
and you will receive a line break!
2016-01-26 08:27:17 +00:00
```
Formatting Text
2016-02-15 06:47:19 +00:00
```
2016-01-26 08:27:17 +00:00
_underscore creates italics_
*asterisks for bold*
*_combine for extra fun_*
`use ticks to signify monospace`
`*bolded monospace*`
```
2016-01-14 04:50:24 +00:00
2016-02-17 13:36:47 +00:00
Section Titles
2016-01-14 04:50:24 +00:00
2016-02-15 06:47:19 +00:00
```
2016-01-14 04:50:24 +00:00
= Level 0 (may only be used in document's header)
2016-01-26 08:27:17 +00:00
== Level 1 < h2 >
2016-01-14 04:50:24 +00:00
2016-01-26 08:27:17 +00:00
=== Level 2 < h3 >
2016-01-14 04:50:24 +00:00
2016-01-26 08:27:17 +00:00
==== Level 3 < h4 >
2016-01-14 04:50:24 +00:00
2016-01-26 08:27:17 +00:00
===== Level 4 < h5 >
2016-01-14 04:50:24 +00:00
2016-01-26 08:27:17 +00:00
====== Level 5 < h6 >
2016-01-14 04:50:24 +00:00
2016-01-26 08:27:17 +00:00
======= Level 6 < h7 >
2016-01-14 04:50:24 +00:00
```
2016-01-26 08:27:17 +00:00
Lists
To create a bulleted list use asterisks.
2016-02-15 06:47:19 +00:00
```
2016-01-26 08:27:17 +00:00
* foo
* bar
* baz
```
To create a numbered list use periods.
2016-02-15 06:47:19 +00:00
```
2016-01-26 08:27:17 +00:00
. item 1
. item 2
. item 3
```
You can nest lists by adding extra asterisks or periods up to five times.
2016-02-15 06:47:19 +00:00
```
2016-01-26 08:27:17 +00:00
* foo 1
** foo 2
*** foo 3
**** foo 4
***** foo 5
2016-02-15 06:47:19 +00:00
2016-01-26 08:27:17 +00:00
. foo 1
.. foo 2
... foo 3
.... foo 4
..... foo 5
```
2017-09-11 17:16:13 +00:00
## Further Reading
There are two tools to process AsciiDoc documents:
1. [AsciiDoc ](http://asciidoc.org/ ): original Python implementation available in the main Linux distributions. Stable and currently in maintenance mode.
2017-09-11 22:10:57 +00:00
2. [Asciidoctor ](http://asciidoctor.org/ ): alternative Ruby implementation, usable also from Java and JavaScript. Under active development, it aims to extend the AsciiDoc syntax with new features and output formats.
2017-09-11 17:16:13 +00:00
Following links are related to `Asciidoctor` implementation:
2017-09-11 22:10:57 +00:00
* [Markdown - AsciiDoc syntax comparison ](http://asciidoctor.org/docs/user-manual/#comparison-by-example ): side-by-side comparison of common Markdown and AsciiDoc elements.
2017-09-11 17:16:13 +00:00
* [Getting started ](http://asciidoctor.org/docs/#get-started-with-asciidoctor ): installation and quick start guides to render simple documents.
* [Asciidoctor User Manual ](http://asciidoctor.org/docs/user-manual/ ): complete single-document manual with syntax reference, examples, rendering tools, amongst others.