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.
Headers are optional and can’t contain blank lines. It must be offset from content by at least one blank line.
= Document Title First sentence of document.
Title and Author
= Document Title First Last <firstname.lastname@example.org> Start of this document.
= Document Title John Doe <email@example.com>; Jane Doe<firstname.lastname@example.org>; Black Beard <email@example.com> Start of a doc with multiple authors.
Revision Line (requires an author line)
= Doc Title V1 Potato Man <firstname.lastname@example.org> v1.0, 2016-01-13 This article about chips is going to be fun.
You don't need anything special for paragraphs. Add a blank line between paragraphs to separate them. To create a line blank add a + and you will receive a line break!
_underscore creates italics_ *asterisks for bold* *_combine for extra fun_* `use ticks to signify monospace` `*bolded monospace*`
= 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>
To create a bulleted list use asterisks.
* foo * bar * baz
To create a numbered list use periods.
. item 1 . item 2 . item 3
You can nest lists by adding extra asterisks or periods up to five times.
* foo 1 ** foo 2 *** foo 3 **** foo 4 ***** foo 5 . foo 1 .. foo 2 ... foo 3 .... foo 4 ..... foo 5
Got a suggestion? A correction, perhaps? Open an Issue on the Github Repo, or make a pull request yourself!
Originally contributed by Ryan Mavilia, and updated by 1 contributor(s).