aboutsummaryrefslogtreecommitdiff
path: root/doc/index.mdwn
blob: e0e40165673a71f5d906a349157e4d7426d6f489 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
[[!template id=links]]

Ikiwiki is a **wiki compiler**. It converts wiki pages into HTML pages
suitable for publishing on a website. Ikiwiki stores pages and history in a
[[revision_control_system|rcs]] such as [[Subversion|rcs/svn]] or [[rcs/Git]].
There are many other [[features]], including support for
[[blogging|blog]] and [[podcasting|podcast]], as well as a large
array of [[plugins]].

Alternatively, think of ikiwiki as a particularly flexible static
site generator with some dynamic features.



## using ikiwiki

[[Setup]] has a tutorial for setting up ikiwiki, or you can read the
[[man_page|usage]]. There are some [[examples]] of things you can do
with ikiwiki, and some [[tips]].  Basic documentation for ikiwiki plugins
and syntax is provided [[here|ikiwiki]]. The [[forum]] is open for
discussions.

All wikis are supposed to have a [[sandbox]], so this one does too.

This site generally runs the latest release of ikiwiki; currently, it runs
ikiwiki [[!version ]].

## developer resources

The [[RoadMap]] describes where the project is going.
[[Bugs]], [[TODO]] items, [[wishlist]] items, and [[patches|patch]]
can be submitted and tracked using this wiki.

Ikiwiki is developed by [[Joey]] and many contributors,
and is [[FreeSoftware]].