]> sipb.mit.edu Git - ikiwiki.git/blob - doc/index.mdwn
a4b2794332d1176d7e1c65ec2b4258a1d12b13df
[ikiwiki.git] / doc / index.mdwn
1 ikiwiki is a wiki compiler. It converts a directory full of wiki pages
2 into html pages suitable for publishing on a website. Unlike a traditional
3 wiki, ikiwiki does not have its own means of storing page history, its own
4 markup language, or support for editing pages online. 
5
6 To use ikiwiki to set up a wiki, you will probably want to use it with a
7 revision control system, such as [[Subversion]], for keeping track of past
8 versions of pages. ikiwiki can run as a Subversion [[post-commit]] hook, so
9 that each committed change to your wiki is immediatly compiled and
10 published.
11
12 See [[Features]] for a current list of ikiwiki's features. [[WhyIkiWiki]]
13 might be useful if you're considering using this.
14
15 [[Setup]] has a tutorial for setting up ikiwki.
16
17 [[TODO]] lists things that need to be added to ikiwiki before most people
18 would consider it a full-fledged wiki.
19
20 All wikis are supposed to have a [[SandBox]], so this one does to.
21
22 ikiwiki is developed by [[Joey]].