Text formatting
- Separate paragraphs with a blank line. Press enter in the middle of a paragraph to force a line break.
- Italicize text by surrounding it with
/slashes/. - Bold text by surrounding it with
*asterisks*. - Underline text by surrounding it with
_underscores_.
Links
- Link to another page by putting brackets around the page title. For
example, to link to the front page you'd write
[front page]. - URLs (
http://www.example.com/) and
e-mail addresses (
john@example.com) are linked
automatically.- You can specify the link text by putting the URL or address in brackets
followed by the text. So for example,
[http://www.example.com/ Click this link!]becomes
Click this link! - You can link to local pages by writing the page URL starting with a slash.
So to link to this page you'd
write
[/help/editing-instructions this page]. - You can link to a page in another
directory by writing the directory name before the page title. So to link
to this page from outside the
/help/directory, you'd write[/help/ editing instructions]. Don't forget the slashes on both ends!
- You can specify the link text by putting the URL or address in brackets
followed by the text. So for example,
Sections and lists
- Create a section heading with equal signs:
== Heading ==. Use dashes for sub-headings. - Create a separator by putting three dashes on a line:
---. - Create a list by starting a line with an asterisk (
*), number (1.), letter (Aora), or roman numeral (Iori).- You can nest lists by indenting items two spaces.
Source code
- You can include source code in a page by surrounding it with
[[double brackets]]. - You can create a block of source code by putting the opening and
closing brackets on separate lines.
- Write the language name after the opening brackets to have the code syntax
highlighted. Ex:
[[C++
int main() { return 0; }
]] - Supported languages: C, C++, Java, PHP and Cyan (my own personal language).
- Write the language name after the opening brackets to have the code syntax
highlighted. Ex:
Note: To include special formatting characters verbatim escape them with
a backslash, \*like this\*.