X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/40ede54675bf39c4d7ba7c5aab80a2ee0e36ef24..883880b46ddc0d650f70bd6ca2a22539ff78f1b6:/doc/index.mdwn?ds=sidebyside diff --git a/doc/index.mdwn b/doc/index.mdwn index e5fbd70d4..e0e401656 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,36 +1,37 @@ -ikiwiki is a **wiki compiler**. It converts wiki pages -into HTML pages suitable for publishing on a website. Unlike many -wikis, ikiwiki does not have its own ad-hoc means of storing page history, -and instead uses a revision control system such as [[Subversion]]. +[[!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]]. -* Ikiwiki has a nice set of wiki [[features]] which can be expanded by - a large array of [[plugins]]. It also has some [[bugs]], a [[TODO]] list, - and a [[RoadMap]]. +Alternatively, think of ikiwiki as a particularly flexible static +site generator with some dynamic features. -[[template id=note text=""" -[[ikiwiki_logo|logo/ikiwiki.png]] -[[Version_2.0|news/ikiwiki_version_2.0]] is now available. -If you use ikiwiki, please list your wiki in [[IkiWikiUsers]]. -Thanks! --[[Joey]] -"""]] -* [[Setup]] has a tutorial for setting up ikiwiki, and [[Usage]] documents - the parameters and usage of the ikiwiki program. There are some - [[examples]] of things you can do with ikiwiki. -* Feel free to post your questions and thoughts about ikiwiki to - [[Discussion]], or [[contact]] the developers. +## using ikiwiki -* [[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. +[[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. -* Developers, please document any ikiwiki patches you have in the - [[PatchQueue]]. +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]]. -All wikis are supposed to have a [[SandBox]], so this one does too. -ikiwiki is developed by [[Joey]] and is [[FreeSoftware]].