Below are some following text formatting rules:
Numbered List
Numbered list items start with one or more hashes (#). The number of hashes indicates the indentation level. An empty line ends the list.
Example:
# One item
# Another item
## One More
Result:
- One item
- Another item
- One More
Definition List
Definition lists start with a semicolon (;), and a colon (:) between term and definition. The number of semicolons indicates the indentation level. An empty line ends the list.
Example:
; foo: a generic placeholder
; bar: a generic placeholder
;; baz: a variation
Result:
- foo
- a generic placeholder
- bar
- a generic placeholder
- baz
- a variation
Tables
Table rows start and end with two vertical bars (||), with two vertical bars between cells. Empty cells fuse with the next cell; in other words, ||||bar|| is a table row with a cell spanning two columns.
Example:
||foo||bar||
||||bar||
Result:
Whitespace around cell-content controls alignment. If you leave whitespace on both sides, the cell is centered. If you leave whitespace on the right, the cell is aligned to the left, and if you leave whitespace on the left, the cell is aligned to the right.
||fnordifnord||
|| foo ||
||bar ||
|| baz||
Result:
Indented Paragraphs
Indented paragraphs start with one or more colons (:). The number of colons indicates the indentation level. An empty line ends the indented paragraph.
Example:
: One item
: Another item
:: One More
Result:
- One item
- Another item
- One More
Headings
Headings are enclosed in equal signs (=) on a line of their own. You can use up to six equal signs to produce headers of level one to six. Level one is the most important one, and should not be used because the page title already uses a level one heading. Using two or three equal signs is recommended (== like this ==).
Example:
=== Heading 3 ===
==== Heading 4 ====
Result:
Heading 3
Heading 4
Horizontal Lines
Four or more consecutive hyphens on a line of their own (—-) are replaced with a horizontal line.
Example:
----
Result:
Source Code
Lines starting with spaces are shown using a fixed width font with whitespace preserved. I suggest to use uniform indentation of four spaces.
Example:
foo bar
Result:
foo bar
Traditional Wiki Markup
Two and three apostrophes are used for emphasis and strong emphasis.
Example:
''two apostrophes'' and '''three apostrophes'''
Result:
two apostrophes and three apostrophes
HTML Tags
Some HTML tags are also allowed. These tags are used exactly like HTML tags.
Example:
<b>this will be bold</b>
Result:
this will be bold
Supported tags without extra configuration:
- em
- Emphasis (usually italics)
- i
- Italics
- strong
- Strong (usually bold)
- b
- Bold
- u
- Underline
- tt
- Teletype (usually monospaced)
See HTML.
Disable Text Formatting Rules
The following tags will disable text formatting rules:
- nowiki
- disable text formatting rules
- code
- monospaced font, disable text formatting rules
- pre
- monospaced fonts, no line wrapping, disable text formatting rules
Example:
<code>[[foo]]</code>
Result:
[[foo]]
Special Link Patterns
In order to link to Request For Comments (RFC), just write them into the text (the keyword RFC and the number should be on the same line).
Example: RFC 822.
In order to link to a book, just write the International Standard Book Number (ISBN) into the text (the keyword ISBN and the number should be on the same line).
Example: ISBN 020171499X (amazon, search)
