git.oblomov.eu Git - ikiwiki/blob - doc/helponformatting.mdwn

   1 ## Help on formatting text
   2
   3 Text on this wiki is written in a form very close to how you might write
   4 text for an email message. This style of text formatting is called [[MarkDown]].
   5
   6 Leave blank lines between paragraphs.
   7
   8 You can \**emphasise*\* or \*\***strongly emphasise**\*\* text by placing it
   9 in single or double asterisks.
  10
  11 To create a list, start each line with an asterisk:
  12
  13 * "* this is my list"
  14 * "* another item"
  15
  16 To make a numbered list, start each line with a number (any number will
  17 do) followed by a period:
  18
  19 1. "1. first line"
  20 2. "2. second line"
  21 2. "2. third line"
  22
  23 To create a header, start a line with one or more `#` characters followed
  24 by a space and the header text. The number of `#` characters controls the
  25 size of the header:
  26
  27 ## ## h2
  28 ### ### h3
  29 #### #### h4
  30
  31 To create a horizontal rule, just write three or more dashes on their own
  32 line:
  33
  34 ----
  35
  36 To quote someone, prefix the quote with ">":
  37
  38 > To be or not to be,
  39 > that is the question.
  40
  41 To write a code block, indent each line with a tab or 8 spaces:
  42
  43         10 PRINT "Hello, world!"
  44         20 GOTO 10
  45
  46 To link to another page on the wiki, place the page's name inside double
  47 square brackets, so you would use `\[[WikiLink]]` to link to [[WikiLink]].
  48
  49 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
  50 \[link text\]\(url\)
  51
  52 ----
  53
  54 Advanced users can use [[PreProcessorDirective]]s to do additional cool
  55 stuff.
  56
  57 Also, if the smiley plugin is enabled in your wiki, you can insert
  58 [[smileys]] and some other useful symbols.