X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/9d7375c3b263e77da29a5db22af480db8b99d990..4293e5bd6b726db8255028d50352b563511f2c16:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index c79aa8f8a..e0e401656 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,30 +1,37 @@ -[[ikiwiki_logo|logo/ikiwiki.png]] -ikiwiki is a **wiki compiler**. It converts 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. -Instead it can use [[Subversion]] (or [[Git]]). +[[!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 list of ikiwiki's features. [[RoadMap]], [[TODO]] - and [[bugs]] might also be of interest. Feel free to post your questions - and thoughts about ikiwiki to [[Discussion]]. +Alternatively, think of ikiwiki as a particularly flexible static +site generator with some dynamic features. -[[template type=note text=""" -If you use ikiwiki, please list your wiki in [[IkiWikiUsers]]. Thanks! -"""]] -* [[Setup]] has a tutorial for setting up ikiwiki, 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. +## using ikiwiki -* Developers, please document any ikiwiki patches you have in the - [[PatchQueue]]. +[[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]]. -All wikis are supposed to have a [[SandBox]], so this one does too. -ikiwiki is developed by [[Joey]] and is [[FreeSoftware]].