X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/588dd6159728536c706de84d853cddf752a6f1aa..33b39968948f2dcda5c073916d797259e441d1de:/doc/index.mdwn?ds=sidebyside diff --git a/doc/index.mdwn b/doc/index.mdwn index 38f3b0da7..e0e401656 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,17 +1,37 @@ -[[logo/ikiwiki.png]] -ikiwiki is a wiki compiler. It converts a directory full of wiki pages -into html pages suitable for publishing on a website. Unlike a traditional -wiki, ikiwiki does not have its own means of storing page history or its own -markup language. Instead it uses [[Subversion]] and [[MarkDown]]. +[[!template id=links]] -* [[News]] is a blog (built using ikiwiki) of news items about ikiwiki. It's the best way to find out when there's a new version to [[Download]]. +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]]. -* See [[Features]] for a current list of ikiwiki's features. [[TODO]] and [[bugs]] might also be of interest. +Alternatively, think of ikiwiki as a particularly flexible static +site generator with some dynamic features. -* [[Setup]] has a tutorial for setting up ikiwki, and [[Usage]] documents the parameters and usage of the ikiwiki program. -* [[Security]] lists potential security problems. ikiwiki is still being developed, and is being written with security as a priority, so don't expect things to stay in this list for long. -All wikis are supposed to have a [[SandBox]], so this one does too. +## 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]]. + -ikiwiki is developed by [[Joey]] and is [[FreeSoftware]].