README.adoc

Try AsciiDoc

There is no reason to prefer Markdown: it has all the features ^[1] and more!

Note	Great projects use it, including Git, WeeChat and Pacman!

Comparison

Table 1. Snippets of markup ^[2]

Link	AsciiDoc	Dummy
	Markdown	[Dummy](http://example.com)
	Textile	"Dummy":http://example.com
Face	AsciiDoc	Either bold or italic
	Markdown	Either bold or italic
	Textile	Either bold or italic
Header	AsciiDoc	== Level 2 ==
	Markdown	## Level 2
	Textile	h2. Level 2

Ruby code to render AsciiDoc

require 'asciidoctor'  # (1)

puts Asciidoctor.render_file('sample.adoc', :header_footer => true)  # (2)

1. Imports the library

2. Reads, parses and renders the file

And here is some silly math: e^πi + 1 = 0 and H₂O.

---

1. See the user guide.

2. More snippets in the cheatsheet