ReStructuredText Syntax
Headings (2nd level)
Section titles are underlined or overlined and underlined. The top level heading must have an overline and underline equal to the length of the heading. Subsequent lower level headings may use any recommended character as an underline in any order. The order enforced will be the order as encountered.
Any of the following characters are recommended for section headings:
= - ` : . ' " ~ ^ _ * + #
heading 3rd level
heading 4th level
heading 5th level
Text Formatting
Markup | Result |
---|---|
*italic* | italic |
**bold** | bold |
Internal Links
Markup | Result |
---|---|
[[Item]] | [[Item]] |
[[Item/SubItem]] | [[Item/SubItem]] |
[[/SubItem]] | [[/SubItem]] |
[[../SiblingItem]] | [[../SiblingItem]] |
[[Item|named link]] | [[Item|named link]] |
[[#anchorname]] | [[#anchorname]] |
[[#anchorname|description]] | [[#anchorname|description]] |
[[Item#anchorname]] | [[Item#anchorname]] |
[[Item#anchorname|description]] | [[Item#anchorname|description]] |
External Links
||<rowbgcolor="#ffffcc" width="50%"> '''Markup''' || '''Result''' || || [[http://moinmo.in/]] || [[http://moinmo.in/]] || || [[http://moinmo.in/|MoinMoin Wiki]] || [[http://moinmo.in/|MoinMoin Wiki]] || || [[http://static.moinmo.in/logos/moinmoin.png]] || [[http://static.moinmo.in/logos/moinmoin.png]] || || {{http://static.moinmo.in/logos/moinmoin.png}} || {{http://static.moinmo.in/logos/moinmoin.png}} || || [[http://static.moinmo.in/logos/moinmoin.png|moinmoin.png]] || [[http://static.moinmo.in/logos/moinmoin.png|moinmoin.png]] || || [[MeatBall:InterWiki]] || [[MeatBall:InterWiki]] || || [MeatBall:InterWiki|InterWiki page on MeatBall]] || [[MeatBall:InterWiki|InterWiki page on MeatBall]] || || [[file://///server/share/filename%20with%20spaces.txt|link to filename.txt]] || [[file://///server/share/filename%20with%20spaces.txt|link to filename.txt]] ||
Blockquotes and Indentations
Indentations in ReST are called Transitions.
To indent test start a line with one or more blanks
Text indented to the 2nd level has more leading blanks than the first level. To continue indentation, use the same number of leading blanks.
To start a second indented paragraph, insert a blank line.
Lists
Unordered Lists
- The first item in a list must be preceded with a blank line
- Bullets can be "*", "+", or "-"
- To start sub-level, insert a blank line
- sub-sub level
- item 3
- item 4
Ordered Lists
The first item of an ordered list should be "1", "A", "a", "I", or "i". To auto-enumerate, use "#" for the subsequent list items.
- item 1
- item 2
- item3
- sub-item A)
- sub-item B)
- sub-sub item I
- sub-sub item II
Definition Lists
term:: definition object:: :: description 1 :: description 2
Horizontal Rules
Tables
There are two types of tables, grid and simple. To use grid tables, you must paint the cells of the table using "+", "-", "|", and "=" characters.
1 | 2 | 3 |
Header 1 | Header 2 | Header 3 |
---|---|---|
body row 1 | column 2 | column 3 |
body row 2 | Cells may span columns. | |
body row 3 | Cells may span rows. |
|
body row 4 |
To create simple tables, use "=" characters to define the width of the cells with a row.
Inputs | Output | |
---|---|---|
A | B | A or B |
False | False | False |
True | False | True |
False | True | True |
True | True | True |
A | B | A and B |
---|---|---|
False | False | False |
True | False | False |
False | True | False |
True | True | True |
Smileys and Icons
:-) ;-) /!(!)
Admonitions
{{{#!wiki caution '''Don't overuse admonitions'''
Admonitions should be used with care. A page riddled with admonitions will look restless and will be harder to follow than a page where admonitions are used sparingly.
Comments ========
Click on "Comments" in edit bar to toggle the
visibility.}}}
This is a wiki parser section with class "comment dashed" (see HelpOnParsers).
Its visibility gets toggled the same way.