doc/index.mdwn

   1 Ikiwiki is a wiki compiler. It converts a directory full of wiki pages
   2 into html pages suitable for publishing on a website. Unlike a traditional
   3 wiki, ikiwiki does not have its own means of storing page history, its own
   4 markup language, or support for editing pages online.
   5
   6 Why call it IkiWiki? Well, partly because I'm sure some people will find
   7 this a pretty Iky Wiki, since it's so different from other Wikis. Partly
   8 because "ikiwiki" is a nice palindrome. Partly because its design turns
   9 the usual design for a Wiki inside-out and backwards.
  10
  11 To use ikiwiki to set up a wiki, you will probably want to use it with a
  12 revision control system, such as [[Subversion]], for keeping track of past
  13 versions of pages. ikiwiki can run as a Subversion [[post-commit]] hook, so
  14 that each committed change to your wiki is immediatly compiled and
  15 published. (It can also be run by hand, by cron, or integrated with any
  16 other revision control system.)
  17
  18 [[Subversion]] also offers a way to let others edit pages on your wiki.
  19 Just configure subversion to let appropriate users (or everyone) commit to
  20 the wiki's repository. There are some things you should keep in mind about
  21 [[Security]] when allowing the world to edit your ikiwiki.
  22
  23 ikiwiki supports pages using [[MarkDown]] as their markup language. Any
  24 page with a filename ending in ".mdwn" is converted from markdown to html
  25 by ikiwiki. Markdown understands text formatted as it would be in an email,
  26 and is quite smart about converting it to html. The only additional markup
  27 provided by ikiwiki aside from regular markdown is the [[WikiLink]].
  28
  29 ikiwiki also supports files of any other type, including raw html, text,
  30 images, etc. These are not converted to wiki pages, they are just copied
  31 unchanged by ikiwiki as it builds your wiki. So you can check in an image,
  32 program, or other special file and link to it from your wiki pages.
  33 ikiwiki also supports making one page that is a [[SubPage]] of another.
  34
  35 [[Setup]] has a tutorial for setting up ikiwki.
  36
  37 [[TODO]] lists things that need to be added to ikiwiki before most people
  38 would consider it a full-fledged wiki.
  39
  40 All wikis are supposed to have a [[SandBox]], so this one does to.
  41
  42 ikiwiki is developed by [[JoeyHess]].