A structured text page consists of a sequence of paragraphs separated by one or more blank lines.
Lists
- A paragraph that begins with a "-", "*", or "o" followed by whitespace is treated as an unordered list (bullet) element. For sublists, use more than one "-", "*", or "o". That is, for a second-level list use "**", "--" or "oo" and so on.
A paragraph that begins with a "^" or sequence of digits followed by a white-space character is treated as an ordered list element. Again, for sublists, use multiple "^"
- A paragraph with a first line that contains some text, followed by some white-space and "--" is treated as a descriptive list element. The leading text is treated as the element title.
Examples
- Text enclosed in single quotes "'" is formatted as example text.
- Indented sub-paragraphs of a paragraph that ends in "::" is treated as example code and is output as is.
Headings
- Text enclosed in "=" characters is made a heading -- the number of "=" characters defines the level of the heading.
Emphasis, Bolding, Underlining
- Text surrounded by "*" characters is emphasized.
- Text surrounded by "**" characters is made strong.
- Text surrounded by "_" underscore characters is made underlined.
Horizontal Rules
A sequence of ---- or more "-" characters by themselves on a line will create a horizontal rule.
Tables
Tables may be created by prefixing the table cells with "||".
- The first cell must appear at the start of the line.
- The cells may be made to span multiple columns and rows by putting numbers between the pipes as in "|c,r|" for "c" columns and "r" rows.
- If only column spanning is required, just put the column span number in there, with no comma as in "|c|".
Alignment may also be specified by placing a "<", ">" or "|" between the pipes, after the column span if one is being specified. For example, "|<|", which is the default left-aligned. "|2||" for two column center-aligned.