X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/0e5c0c466045a97f5bbf38630c270f3c24eb80ff..068fa7d079195d66ade6728963d9f9102588d09c:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index 981c4a682..14d1dd1cf 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,21 +1,35 @@ -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]]. +[[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]]. * [[News]] is a blog (built using ikiwiki) of news items about ikiwiki. - Yes, it's free software, yes you can [[Download]] it. + It's the best way to find out when there's a new version to [[Download]]. + +* Ikiwiki has a nice set of wiki [[features]] which can be expanded by + a large array of [[plugins]]. It also has some [[bugs]], a [[TODO]] list, + and a [[RoadMap]]. + +[[template id=note text=""" +If you use ikiwiki, please list your wiki in [[IkiWikiUsers]]. +Thanks! --[[Joey]] +"""]] -* 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 ikiwiki, and [[Usage]] documents + the parameters and usage of the ikiwiki program. There are some + [[examples]] of things you can do with ikiwiki. -* [[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]], or [[contact]] the developers. -* [[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. +* [[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. -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` +* 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]].