X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f6cf98215282e4d838c27384c76548b333518c50..bbc6cd7d57c621dbad097867bca996ad910d64ca:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index 51b6f3481..9d1110772 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,18 +1,24 @@ -Welcome to the ikiwiki documentation wiki. +Ikiwiki is a **wiki compiler**. It converts wiki pages +into HTML pages suitable for publishing on a website. Ikiwiki stores +pages and history in a revision control system such as [[Subversion]] +or [[Git]]. There are many other [[features]], including support for +[[blogging|blog]], as well as a large array of [[plugins]]. -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]]. +[[template id=links]] -* See [[Features]] for a current list of ikiwiki's features. [[TODO]] and [[bugs]] might also be of interest. +## using 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 ikiwiki, or you can read the +[[man_page|usage]]. There are some [[examples]] of things you can do + with ikiwiki, and some [[tips]]. -* [[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. +All wikis are supposed to have a [[SandBox]], so this one does too. -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` +## developer resources -All wikis are supposed to have a [[SandBox]], so this one does too. +The [[RoadMap]] describes where the project is going. +[[Bugs]], [[TODO]] items, [[wishlist]] items, and [[patches|patch]] +can be submitted and tracked using this wiki. -ikiwiki is developed by [[Joey]]. +ikiwiki is developed by [[Joey]] and many contributors, +and is [[FreeSoftware]].