summaryrefslogtreecommitdiffhomepage
path: root/asciidoc.html.markdown
diff options
context:
space:
mode:
authorAdam Bard <github@adambard.com>2016-02-14 22:46:10 -0800
committerAdam Bard <github@adambard.com>2016-02-14 22:46:10 -0800
commitd1762ab9878728bfa8aa489b332bb4c92a421b46 (patch)
tree1785af60026e33b03ffbcbe26f510a358ab50149 /asciidoc.html.markdown
parent4ffe2efc7a70534a61ed1abc88f51feab337afb9 (diff)
parent083aa4fa4c462cbd9b5f9b3c671969d7d3d6976c (diff)
Merge pull request #2104 from ryanmavilia/master
[asciidoc/en-us] Start Asciidoc
Diffstat (limited to 'asciidoc.html.markdown')
-rw-r--r--asciidoc.html.markdown120
1 files changed, 120 insertions, 0 deletions
diff --git a/asciidoc.html.markdown b/asciidoc.html.markdown
new file mode 100644
index 00000000..f9ca8e21
--- /dev/null
+++ b/asciidoc.html.markdown
@@ -0,0 +1,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
+```
+
+
+