X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/f8ffce3e4467049c8b351c0e775f9a291bd75d30..068fa7d079195d66ade6728963d9f9102588d09c:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index 04a4f79d2..14d1dd1cf 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,16 +1,34 @@ [[ikiwiki_logo|logo/ikiwiki.png]] ikiwiki is a **wiki compiler**. It converts 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 can use [[Subversion]] (or [[Git]]) and [[MarkDown]]. +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. It's the best way to find out when there's a new version to [[Download]]. +* [[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 list of ikiwiki's features. [[RoadMap]], [[TODO]] and [[bugs]] might also be of interest. Feel free to post your thoughts about ikiwiki to [[Discussion]]. +* 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]]. -* [[Setup]] has a tutorial for setting up ikiwki, and [[Usage]] documents the parameters and usage of the ikiwiki program. If you use ikiwiki, please add your wiki to [[IkiWikiUsers]]. +[[template id=note text=""" +If you use ikiwiki, please list your wiki in [[IkiWikiUsers]]. +Thanks! --[[Joey]] +"""]] -* [[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. +* [[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. + +* 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. + +* Developers, please document any ikiwiki patches you have in the + [[PatchQueue]]. All wikis are supposed to have a [[SandBox]], so this one does too.