X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/088dccb3f963e181ab27434f00deba4c0d65633c..531df235c798b893c0a7bc9cc93defda35af3137:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index 41c3db9e8..29d82463d 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,17 +1,34 @@ -[[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 hostory 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]]. -* [[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=note text=""" +[[ikiwiki_logo|logo/ikiwiki.png]] +Quick links: +[[News]] +[[Download]] +[[Setup]] +[[Usage]] +[[Security]] +[[IkiWikiUsers]] +[[Contact]] +"""]] -* 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. 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, and [[Usage]] documents +the parameters and usage of the ikiwiki program. 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]] +can be submitted and tracked using this wiki. + +ikiwiki is developed by [[Joey]] and many contributors, +and is [[FreeSoftware]].