X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/ff34c32de0944dc5350260de3899f678898ac4bc..1d8e719e6ae0ef7aaa35510102c0a55fd3cd740b:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index b33df6056..51b6f3481 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,16 +1,18 @@ +Welcome to the ikiwiki documentation wiki. + 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 or its own markup language. Instead it uses [[Subversion]] and [[MarkDown]]. -See [[Features]] for a current list of ikiwiki's features. [[WhyIkiWiki]] -might be useful if you're considering using this. +* See [[Features]] for a current list of ikiwiki's features. [[TODO]] and [[bugs]] might also be of interest. + +* [[Setup]] has a tutorial for setting up ikiwki, and [[Usage]] documents the parameters and usage of the ikiwiki program. -[[Setup]] has a tutorial for setting up ikiwki. +* [[Security]] lists potential security problems. ikiwiki is still being developed, and is being written with security as a priority, so don't expect things to stay in this list for long. -[[TODO]] lists things that need to be added to ikiwiki before most people -would consider it a full-fledged wiki. +Ikiwiki is _not_ yet formally released, although it's very close to being ready for a release now. If you really have to have it: `svn://svn.kitenet.net/ikiwiki/trunk` -All wikis are supposed to have a [[SandBox]], so this one does to. +All wikis are supposed to have a [[SandBox]], so this one does too. ikiwiki is developed by [[Joey]].