summaryrefslogtreecommitdiffhomepage
path: root/asciidoc.html.markdown
blob: b98d0fa965d660ef87467429eaffee1a9bedc457 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
---
language: asciidoc
contributors:
    - ["Ryan Mavilia", "http://unoriginality.rocks/:]
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

```asciidoc
= Document Title

First sentence of document.
```

Title and Author

```asciidoc
= Document Title
First Last <first.last@learnxinyminutes.com>

Start of this document.
```

Multiple Authors
```asciidoc
= 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)
```asciidoc
= Doc Title V1
Potato Man <chip@crunchy.com>
v1.0, 2016-01-13

This article about chips is going to be fun.
```

Section Titles 

```asciidoc
= Level 0 (may only be used in document's header)

== Same as <h2>

=== Same as <h3>

==== Same as <h4>

===== Same as  <h5>

====== Same as <h6>

======= Same as <h7>

```