X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/f4a6a03de6b64252006d7b56314450f6d8b4fa20..729de2486c98bc5f5d24ad0e1f215f3ea7b98917:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index 435454ab3..9d1110772 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,20 +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. +## 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]]. -* [[TODO]] and [[bugs]] lists things that need to be added to ikiwiki before most people would consider it a full-fledged wiki. - -* [[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. 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]].