clarify
[ikiwiki] / doc / index.mdwn
1 ikiwiki is a **wiki compiler**. It converts wiki pages
2 into HTML pages suitable for publishing on a website. Unlike many
3 wikis, ikiwiki does not have its own ad-hoc means of storing page history,
4 and instead uses a revision control system such as [[Subversion]].
5
6 * [[News]] is a blog (built using ikiwiki) of news items about ikiwiki.
7   It's the best way to find out when there's a new version to [[Download]].
8
9 * Ikiwiki has a nice set of wiki [[features]] which can be expanded by
10   a large array of [[plugins]]. It also has some [[bugs]], a [[TODO]] list,
11   and a [[RoadMap]].
12
13 [[template id=note text="""
14 [[ikiwiki_logo|logo/ikiwiki.png]]  
15 If you use ikiwiki, please list your wiki in [[IkiWikiUsers]].
16 Thanks! --[[Joey]]
17 """]]
18
19 * [[Setup]] has a tutorial for setting up ikiwiki, and [[Usage]] documents
20   the parameters and usage of the ikiwiki program. There are some
21   [[examples]] of things you can do with ikiwiki.
22
23 * Feel free to post your questions and thoughts about ikiwiki to
24   [[Discussion]], or [[contact]] the developers.
25
26 * [[Security]] lists potential security problems. ikiwiki is still being
27   developed, and is being written with security as a priority, so don't
28   expect things to stay in this list for long.
29
30 * Developers, please document any ikiwiki patches you have in the
31   [[PatchQueue]].
32
33 All wikis are supposed to have a [[SandBox]], so this one does too.
34
35 ikiwiki is developed by [[Joey]] and is [[FreeSoftware]].