X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/512610642a4738fe7f57c188d16f322b7aacb220..ae4dccc1beffa5bd03bf6284f476bbf83d5e6fe5:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index 8b7e74959..029925722 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,17 +1,24 @@ -[[ikiwiki_logo|logo/ikiwiki.png]] -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]]. +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|rcs]] such as [[Subversion|rcs/svn]] or [[rcs/Git]]. +There are many other [[features]], including support for [[blogging|blog]], +as well as a large array of [[plugins]]. -* [[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]]. +[[template id=links]] -* See [[Features]] for a list of ikiwiki's features. [[RoadMap]], [[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. If you use ikiwiki, please add your wiki to [[IkiWikiUsers]]. - -* [[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, or you can read the +[[man_page|usage]]. There are some [[examples]] of things you can do + with ikiwiki, and some [[tips]]. All wikis are supposed to have a [[SandBox]], so this one does too. -ikiwiki is developed by [[Joey]] and is [[FreeSoftware]]. +## developer resources + +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 many contributors, +and is [[FreeSoftware]].