X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/44eaf2de1067a90be94ce74cbd56c2e86d2087de..531df235c798b893c0a7bc9cc93defda35af3137:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index 18ea5614e..29d82463d 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,27 +1,34 @@ -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, its own -markup language, or support for editing pages online. +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]]. -To use ikiwiki to set up a wiki, you will probably want to use it with a -revision control system, such as [[Subversion]], for keeping track of past -versions of pages. ikiwiki can run as a Subversion [[post-commit]] hook, so -that each committed change to your wiki is immediatly compiled and -published. +[[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. [[WhyIkiWiki]] -might be useful if you're considering using this. +### using ikiwiki -[[Subversion]] also offers a way to let others edit pages on your wiki. -Just configure subversion to let appropriate users (or everyone) commit to -the wiki's repository. There are some things you should keep in mind about -[[Security]] when allowing the world to edit your ikiwiki. +[[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]]. -[[Setup]] has a tutorial for setting up ikiwki. +All wikis are supposed to have a [[SandBox]], so this one does too. -[[TODO]] lists things that need to be added to ikiwiki before most people -would consider it a full-fledged wiki. +### developer resources -All wikis are supposed to have a [[SandBox]], so this one does to. +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]]. +ikiwiki is developed by [[Joey]] and many contributors, +and is [[FreeSoftware]].