mirror of
https://github.com/adambard/learnxinyminutes-docs.git
synced 2025-01-17 21:49:22 +01:00
Fix up asciidoc
This commit is contained in:
parent
d1762ab987
commit
0c020f4da8
@ -13,7 +13,7 @@ Headers are optional and can't contain blank lines. It must be offset from conte
|
|||||||
|
|
||||||
Title Only
|
Title Only
|
||||||
|
|
||||||
```asciidoc
|
```
|
||||||
= Document Title
|
= Document Title
|
||||||
|
|
||||||
First sentence of document.
|
First sentence of document.
|
||||||
@ -21,7 +21,7 @@ First sentence of document.
|
|||||||
|
|
||||||
Title and Author
|
Title and Author
|
||||||
|
|
||||||
```asciidoc
|
```
|
||||||
= Document Title
|
= Document Title
|
||||||
First Last <first.last@learnxinyminutes.com>
|
First Last <first.last@learnxinyminutes.com>
|
||||||
|
|
||||||
@ -29,7 +29,8 @@ Start of this document.
|
|||||||
```
|
```
|
||||||
|
|
||||||
Multiple Authors
|
Multiple Authors
|
||||||
```asciidoc
|
|
||||||
|
```
|
||||||
= Document Title
|
= Document Title
|
||||||
John Doe <john@go.com>; Jane Doe<jane@yo.com>; Black Beard <beardy@pirate.com>
|
John Doe <john@go.com>; Jane Doe<jane@yo.com>; Black Beard <beardy@pirate.com>
|
||||||
|
|
||||||
@ -37,16 +38,18 @@ Start of a doc with multiple authors.
|
|||||||
```
|
```
|
||||||
|
|
||||||
Revision Line (requires an author line)
|
Revision Line (requires an author line)
|
||||||
```asciidoc
|
|
||||||
|
```
|
||||||
= Doc Title V1
|
= Doc Title V1
|
||||||
Potato Man <chip@crunchy.com>
|
Potato Man <chip@crunchy.com>
|
||||||
v1.0, 2016-01-13
|
v1.0, 2016-01-13
|
||||||
|
|
||||||
This article about chips is going to be fun.
|
This article about chips is going to be fun.
|
||||||
```
|
```
|
||||||
|
|
||||||
Paragraphs
|
Paragraphs
|
||||||
|
|
||||||
```asciidoc
|
```
|
||||||
You don't need anything special for paragraphs.
|
You don't need anything special for paragraphs.
|
||||||
|
|
||||||
Add a blank line between paragraphs to seperate them.
|
Add a blank line between paragraphs to seperate them.
|
||||||
@ -57,7 +60,7 @@ and you will recieve a line break!
|
|||||||
|
|
||||||
Formatting Text
|
Formatting Text
|
||||||
|
|
||||||
```asciidoc
|
```
|
||||||
_underscore creates italics_
|
_underscore creates italics_
|
||||||
*asterisks for bold*
|
*asterisks for bold*
|
||||||
*_combine for extra fun_*
|
*_combine for extra fun_*
|
||||||
@ -67,7 +70,7 @@ _underscore creates italics_
|
|||||||
|
|
||||||
Section Titles
|
Section Titles
|
||||||
|
|
||||||
```asciidoc
|
```
|
||||||
= Level 0 (may only be used in document's header)
|
= Level 0 (may only be used in document's header)
|
||||||
|
|
||||||
== Level 1 <h2>
|
== Level 1 <h2>
|
||||||
@ -87,34 +90,33 @@ Section Titles
|
|||||||
Lists
|
Lists
|
||||||
|
|
||||||
To create a bulleted list use asterisks.
|
To create a bulleted list use asterisks.
|
||||||
```asciidoc
|
|
||||||
|
```
|
||||||
* foo
|
* foo
|
||||||
* bar
|
* bar
|
||||||
* baz
|
* baz
|
||||||
```
|
```
|
||||||
|
|
||||||
To create a numbered list use periods.
|
To create a numbered list use periods.
|
||||||
```asciidoc
|
|
||||||
|
```
|
||||||
. item 1
|
. item 1
|
||||||
. item 2
|
. item 2
|
||||||
. item 3
|
. item 3
|
||||||
```
|
```
|
||||||
|
|
||||||
You can nest lists by adding extra asterisks or periods up to five times.
|
You can nest lists by adding extra asterisks or periods up to five times.
|
||||||
```asciidoc
|
|
||||||
|
```
|
||||||
* foo 1
|
* foo 1
|
||||||
** foo 2
|
** foo 2
|
||||||
*** foo 3
|
*** foo 3
|
||||||
**** foo 4
|
**** foo 4
|
||||||
***** foo 5
|
***** foo 5
|
||||||
```
|
|
||||||
```asciidoc
|
|
||||||
. foo 1
|
. foo 1
|
||||||
.. foo 2
|
.. foo 2
|
||||||
... foo 3
|
... foo 3
|
||||||
.... foo 4
|
.... foo 4
|
||||||
..... foo 5
|
..... foo 5
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user