e3b0ceb0d15576125fd8dac8f1bb32e5c64e485c
[ikiwiki.git] / doc / index.mdwn
1 [[ikiwiki_logo|logo/ikiwiki.png]]  
2 ikiwiki is a **wiki compiler**. It converts wiki pages
3 into HTML pages suitable for publishing on a website. Unlike many
4 wikis, ikiwiki does not have its own ad-hoc means of storing page history,
5 and instead uses a revision control system such as [[Subversion]].
6
7 * [[News]] is a blog (built using ikiwiki) of news items about ikiwiki.
8   It's the best way to find out when there's a new version to [[Download]].
9
10 * Ikiwiki has a nice set of wiki [[features]] which can be expanded by
11   a large array of [[plugins]]. It also has some [[bugs]], a [[TODO]] list,
12   and a [[RoadMap]].
13
14 [[template id=note text="""
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]].  You could also drop by the IRC channel `#ikiwiki` on OFTC
25   (`irc.oftc.net`).  [[ikiwiki_does_not_have_a_mailing_list|mailing_list]]; we
26   use the wiki instead.
27
28 * [[Security]] lists potential security problems. ikiwiki is still being
29   developed, and is being written with security as a priority, so don't
30   expect things to stay in this list for long.
31
32 * Developers, please document any ikiwiki patches you have in the
33   [[PatchQueue]].
34
35 All wikis are supposed to have a [[SandBox]], so this one does too.
36
37 ikiwiki is developed by [[Joey]] and is [[FreeSoftware]].