]> sipb.mit.edu Git - ikiwiki.git/commitdiff
add helponformatting page
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Sun, 19 Mar 2006 21:25:47 +0000 (21:25 +0000)
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Sun, 19 Mar 2006 21:25:47 +0000 (21:25 +0000)
doc/helponformatting.mdwn [new file with mode: 0644]
doc/sandbox.mdwn

diff --git a/doc/helponformatting.mdwn b/doc/helponformatting.mdwn
new file mode 100644 (file)
index 0000000..2238fcb
--- /dev/null
@@ -0,0 +1,55 @@
+## 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:
+
+* \* this is my list
+* \* another item
+
+To make a numbered list, start each line with a number (any number will
+do) followed by a period:
+
+1. 1\. first line
+2. 2\. second line
+2. 2\. third line
+
+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:
+
+## h2
+### h3
+#### h4
+
+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
+square brackets to create a [[[[WikiLink]]]].
+
+To link to any other web page, you can just put the url in angle brackets:
+<<http://ikiwiki.kitenet.net>>, or you can use the form
+\[link text\]\(url\)
+
+----
+
+This style of text formatting is called [[MarkDown]].
index 072f8908aab46a8acdebccaf0020c92133cf7a89..d39f760329e23b5d6ad3a521572de49df6ae2fb1 100644 (file)
@@ -1,7 +1,5 @@
 This is the SandBox, a page anyone can edit to try out ikiwiki.
 
-See [[MarkDown]] for documentation of the markup syntax used on this page.
-
 ----
 
 Here's a paragraph.