X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/44eaf2de1067a90be94ce74cbd56c2e86d2087de..e4da88917e8c50460945bd4c63561274104c6bae:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index 18ea5614e..8ab195598 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,27 +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, 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 -revision control system, such as [[Subversion]], for keeping track of past -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. +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. -[[Subversion]] also offers a way to let others edit pages on your wiki. -Just configure subversion to let appropriate users (or everyone) commit to -the wiki's repository. There are some things you should keep in mind about -[[Security]] when allowing the world to edit your ikiwiki. +* [[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. 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]].