Formatting Rules
General Rule
Escape and Entity
You can use HTML entity.
-
A single "&" followed by chars/symbols ends with ";" is an entity.
-
A single "&" followed by "&" or whitespace is just the symbol.
e.g. © -> ©
& -> &
&& -> &
Entities for Symbols
Following entities might be necessary to represent those symbols themselves.
&[; -> [
&]; -> ]
&{; -> {
&}; -> }
&(; -> (
&); -> )
&'; -> '
&_; -> _
&%; -> %
&|; -> |
&`; -> `
&:; -> :
&=; -> =
&[[; -> [[
&]]; -> ]]
[[ and ]] have a special meaning.
Therefore, you must use &[[;, &]]; to represent the characters themselves.
HTML Tags
You can't use HTML tags. "<" and ">" will be displayed as those symbols.
Line Break
A newline actually breaks a line.
If you put a underscore "_" at the end of a line, then the following line
will be connected to the line.
e.g.
This is _
a pen and that is _
a pencil.
This is a pen and that is a pencil.
Format Indicator
A "Format Indicator" is a special characters which indicates a block, which are Sections, Horizontal Line, Lists, etc. described below.
If ` is located at the top of those command lines, it will be eliminated.
Section Headers
Put an asterisk marks "*" at the start of a line.
* for H1, ** for H2, *** for H3, **** for H4.
Using "**" is recommended.
H1 Header
H2 Header
H3 Header
H4 Header
A line with five equal marks alone "*****" create a "more..." block.
Horizontal Line
A line with four or more equal signs "====" at the start of a line becomes a
horizontal line.
E.g.
====
will be like below:
