Markdown vs. reStructuredText

Created on Sept. 3, 2012, 8:15 p.m. by Hevok & updated by Hevok on May 2, 2013, 5:10 p.m.

Denigma supports multiple markup language including the two big ones Markdown and reStructuredText.

Markdown is easier to use and often preferred when the purpose is simply to generate HTML. In contrast, reStructuredText is more extensible and powerful, with native support for tables and as well as automatic generation of table of contents and interlinking.

Indentation is significant to both Markdown and reStructuredText, but in different ways.

Markdown supports nested bold and italics, reST not (so there is no way to represent bold italics).

Markdown can be used to format entries: ::

> quoted text
*italic* text
**bold** text
`code block` (multi-line is fine, whitespace is preserved)
[link text](http://www.google.com "link title")

Becomes to:

quoted text italic text bold text code block (multi-line is fine, whitespace is preserved) link text


Markdown:

# Title

## Header
First Paragraph.

Second Paragraph.

### Subheader
First Paragraph

Second Paragraph

#### SubSubheader
First Paragraph

Second Paragraph

reStructuredText:

=====
Title
=====

Header
======
First Paragraph.

Second Paragraph.


Subheader
---------
First Paragraph.

Second Paragraph.


SubSubheader
~~~~~~~~~~~~
First Paragraph.

Second Paragraph.


Markdown:

Title

Header

First Paragraph.

Second Paragraph.

Subheader

First Paragraph

Second Paragraph

SubSubheader

First Paragraph

Second Paragraph

reStructuredText:

===== Title =====

Header

First Paragraph.

Second Paragraph.

Subheader

First Paragraph.

Second Paragraph.

SubSubheader ~~~~~~~~~~~~

First Paragraph.

Second Paragraph.


Tags: tutorial, documentation, markup
Categories: Tutorial
Parent: Markup

Update entry (Admin) | See changes

Comment on This Data Unit