]> sipb.mit.edu Git - ikiwiki.git/blob - doc/index.mdwn
web commit from 66.118.98.137:
[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 [[Subversion]] also offers a way to let others edit pages on your wiki.
16 Just configure subversion to let appropriate users (or everyone) commit to
17 the wiki's repository. There are some things you should keep in mind about
18 [[Security]] when allowing the world to edit your ikiwiki.
19
20 ikiwiki also supports files of any other type, including raw html, text,
21 images, etc. These are not converted to wiki pages, they are just copied
22 unchanged by ikiwiki as it builds your wiki. So you can check in an image,
23 program, or other special file and link to it from your wiki pages.
24 ikiwiki also supports making one page that is a [[SubPage]] of another.
25
26 [[Setup]] has a tutorial for setting up ikiwki.
27
28 [[TODO]] lists things that need to be added to ikiwiki before most people
29 would consider it a full-fledged wiki.
30
31 All wikis are supposed to have a [[SandBox]], so this one does to.
32
33 ikiwiki is developed by [[Joey]].