]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/helponformatting.mdwn
web commit by JoshTriplett: Avoid suggesting that only advanced users can use [[PrePr...
[ikiwiki.git] / doc / helponformatting.mdwn
index 1e3958a6120b16bd6e87f6cb87aaf901aaddb26c..8c6483275f8e262910a963993e886dbc53215d16 100644 (file)
@@ -1,7 +1,8 @@
-## Help on formatting text
+# 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. This style of text formatting is called [[MarkDown]].
+Text on this wiki is, by default, written in a form very close to how you
+might write text for an email message. This style of text formatting is
+called [[MarkDown]], and it works like this:
 
 Leave blank lines between paragraphs.
 
@@ -24,12 +25,30 @@ 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:
 
+# # h1
 ## ## h2
 ### ### h3
 #### #### h4
+##### ##### h5
+###### ###### h6
 
-To create a horizontal rule, just write three or more dashes on their own
-line:
+You can also make the first two levels of heading by underlining text with
+equals or dash:
+
+heading 1
+=========
+
+    heading 1
+    =========
+
+heading 2
+---------
+
+    heading 2
+    ---------
+
+To create a horizontal rule, just write three or more dashes or stars on
+their own line:
 
 ----
 
@@ -38,7 +57,7 @@ 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 or 8 spaces:
+To write a code block, indent each line with a tab or 4 spaces:
 
        10 PRINT "Hello, world!"
        20 GOTO 10
@@ -51,8 +70,7 @@ To link to any other web page, or to an email address, you can just put the url
 
 ----
 
-Advanced users can use [[PreProcessorDirective]]s to do additional cool
-stuff.
+You can also use [[PreProcessorDirective]]s to do additional cool stuff.
 
 Also, if the smiley plugin is enabled in your wiki, you can insert
 [[smileys]] and some other useful symbols.