X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/a591d11c0011b280ed59397eb869c6c4bb1b1493..2ff6e2455719f7dc550f8383ee9f952b35d38184:/doc/index.mdwn?ds=sidebyside diff --git a/doc/index.mdwn b/doc/index.mdwn index e97bf5796..9d1110772 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,18 +1,24 @@ -[[logo/ikiwiki.png]] 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]] -* [[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]]. +## using ikiwiki -* 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, or you can read the +[[man_page|usage]]. There are some [[examples]] of things you can do + with ikiwiki, and some [[tips]]. -* [[Setup]] has a tutorial for setting up ikiwki, and [[Usage]] documents the parameters and usage of the ikiwiki program. +All wikis are supposed to have a [[SandBox]], so this one does too. -* [[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. +## 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]] and is [[FreeSoftware]]. +ikiwiki is developed by [[Joey]] and many contributors, +and is [[FreeSoftware]].