X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/a80f0c6e4fc4aa7b7504ce7bb1f782298078c41d..3e593eb9c0edd3f5cce7381ca145c0889441d719:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index 6618e47f1..22a08c00b 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,18 +1,33 @@ -Welcome to the ikiwiki documentation wiki. +[[ikiwiki_logo|logo/ikiwiki.png]] +ikiwiki is a **wiki compiler**. It converts wiki pages +into html pages suitable for publishing on a website. Unlike many +wikis, ikiwiki does not have its own ad-hoc means of storing page history, +and instead uses a revision control system such as [[Subversion]]. -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]]. +* [[News]] is a blog (built using ikiwiki) of news items about ikiwiki. + It's the best way to find out when there's a new version to [[Download]]. -* See [[Features]] for a current list of ikiwiki's features. [[TODO]] and [[bugs]] might also be of interest. +* See [[Features]] for a list of ikiwiki's features and [[plugins]] for information about its plugins. [[RoadMap]], [[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. +* Feel free to post your questions and thoughts about ikiwiki to [[Discussion]]. -* [[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. +[[template id=note text=""" +If you use ikiwiki, please list your wiki in [[IkiWikiUsers]]. +Thanks! --[[Joey]] +"""]] -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 +* [[Setup]] has a tutorial for setting up ikiwiki, and [[Usage]] documents + the parameters and usage of the ikiwiki program. There are some + [[examples]] that you can copy into your wiki to quickly get started. + +* [[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. + +* Developers, please document any ikiwiki patches you have in the + [[PatchQueue]]. All wikis are supposed to have a [[SandBox]], so this one does too. -ikiwiki is developed by [[Joey]]. +ikiwiki is developed by [[Joey]] and is [[FreeSoftware]].