ikiwiki/doc/helponformatting.mdwn

60 lines
1.4 KiB
Plaintext
Raw Normal View History

2006-03-19 22:25:47 +01:00
## Help on formatting text
Text on this wiki is written in a form very close to how you might write
text for an email message.
Leave blank lines between paragraphs.
You can \**emphasise*\* or \*\***strongly emphasise**\*\* text by placing it
in single or double asterisks.
To create a list, start each line with an asterisk:
2006-03-19 22:30:21 +01:00
* "* this is my list"
* "* another item"
2006-03-19 22:25:47 +01:00
To make a numbered list, start each line with a number (any number will
do) followed by a period:
2006-03-19 22:30:21 +01:00
1. "1. first line"
2. "2. second line"
2. "2. third line"
2006-03-19 22:25:47 +01:00
To create a header, start a line with one or more `#` characters followed
by a space and the header text. The number of `#` characters controls the
size of the header:
2006-03-19 22:30:21 +01:00
## ## h2
### ### h3
#### #### h4
2006-03-19 22:25:47 +01:00
To create a horizontal rule, just write three or more dashes on their own
line:
----
To quote someone, prefix the quote with ">":
> To be or not to be,
> that is the question.
To write a code block, indent each line with a tab:
10 PRINT "Hello, world!"
20 GOTO 10
To link to another page on the wiki, place the page's name inside double
2006-03-19 22:30:21 +01:00
square brackets, so you would use `\[[WikiLink]]` to link to [[WikiLink]].
2006-03-19 22:25:47 +01:00
2006-03-19 22:30:21 +01:00
To link to any other web page, or to an email address, you can just put the url in angle brackets: <<http://ikiwiki.kitenet.net>>, or you can use the form
2006-03-19 22:25:47 +01:00
\[link text\]\(url\)
----
Advanced users can use [[PostProcessorDirective]]s to do additional cool
stuff.
----
2006-03-19 22:25:47 +01:00
This style of text formatting is called [[MarkDown]].