X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/2ecb2171c6eb445716fc09367eed728e524ecddf..85f7f4086376d9c7f4433f8c65c1e8f426a54aff:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index 3d10751c6..67f099210 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,16 +1,30 @@ [[ikiwiki_logo|logo/ikiwiki.png]] -ikiwiki is a **wiki compiler**. It converts a directory full of wiki pages +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 uses [[Subversion]] and [[MarkDown]]. +wiki, ikiwiki does not have its own means of storing page history. +Instead it can use [[Subversion]] (or [[Git]] or [[tla]]). -* [[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]]. +* See [[Features]] for a list of ikiwiki's features. [[RoadMap]], [[TODO]] + and [[bugs]] might also be of interest. Feel free to post your questions + and thoughts about ikiwiki to [[Discussion]]. -* [[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. + +* [[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.