up
[ikiwiki.git] / doc / index.mdwn
index 327e685afd8c5f8be9bbfd4cccf1caa694b64045..984d2c9b9f619f2bfbee7a5a81107c3d5a7fa65e 100644 (file)
@@ -1,11 +1,16 @@
-[[Ikiwiki]] is a wiki compiler. It converts a directory full of wiki pages
+Ikiwiki is a wiki compiler. It converts a directory full of wiki pages
 into html pages suitable for publishing on a website. Unlike a traditional
 wiki, ikiwiki does not have its own means of storing page history, its own
 markup language, or support for editing pages online. 
 
-To use [[ikiwiki]] to set up a wiki, you will probably want to use it with a
+Why call it IkiWiki? Well, partly because I'm sure some people will find
+this a pretty Iky Wiki, since it's so different from other Wikis. Partly
+because "ikiwiki" is a nice palindrome. Partly because its design turns
+the usual design for a Wiki inside-out and backwards.
+
+To use ikiwiki to set up a wiki, you will probably want to use it with a
 revision control system, such as [[Subversion]], for keeping track of past
-versions of pages. ikiwiki can run as a Subversion post-commit hook, so
+versions of pages. ikiwiki can run as a Subversion [[post-commit]] hook, so
 that each committed change to your wiki is immediatly compiled and
 published. (It can also be run by hand, by cron, or integrated with any
 other revision control system.) 
@@ -27,10 +32,11 @@ unchanged by ikiwiki as it builds your wiki. So you can check in an image,
 program, or other special file and link to it from your wiki pages.
 ikiwiki also supports making one page that is a [[SubPage]] of another.
 
+[[Setup]] has a tutorial for setting up ikiwki.
+
 [[TODO]] lists things that need to be added to ikiwiki before most people
 would consider it a full-fledged wiki.
 
 All wikis are supposed to have a [[SandBox]], so this one does to.
-If you'd like to try editing pages on this wiki, do whatever you'd like in 
 
-[[ikiwiki]] is developed by JoeyHess.
+ikiwiki is developed by [[JoeyHess]].