blob: 4196e4247b190794be5b3ff3e3023cf20a131055 (
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
---
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.
```
Paragraphs
```asciidoc
You don't need anything special for paragraphs.
Add a blank line between paragraphs to seperate them.
To create a line blank add a +
and you will recieve a line break!
```
Formatting Text
```asciidoc
_underscore creates italics_
*asterisks for bold*
*_combine for extra fun_*
`use ticks to signify monospace`
`*bolded monospace*`
```
Section Titles
```asciidoc
= Level 0 (may only be used in document's header)
== Level 1 <h2>
=== Level 2 <h3>
==== Level 3 <h4>
===== Level 4 <h5>
====== Level 5 <h6>
======= Level 6 <h7>
```
Lists
To create a bulleted list use asterisks.
```asciidoc
* foo
* bar
* baz
```
To create a numbered list use periods.
```asciidoc
. item 1
. item 2
. item 3
```
You can nest lists by adding extra asterisks or periods up to five times.
```asciidoc
* foo 1
** foo 2
*** foo 3
**** foo 4
***** foo 5
```
```asciidoc
. foo 1
.. foo 2
... foo 3
.... foo 4
..... foo 5
```
|
