X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/44eaf2de1067a90be94ce74cbd56c2e86d2087de..28c3e5482d7431b7554e6288bb2f9f55fbd274ed:/doc/index.mdwn?ds=sidebyside diff --git a/doc/index.mdwn b/doc/index.mdwn index 18ea5614e..e0e401656 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,27 +1,37 @@ -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, its own -markup language, or support for editing pages online. +[[!template id=links]] -To use ikiwiki to set up a wiki, you will probably want to use it with a -revision control system, such as [[Subversion]], for keeping track of past -versions of pages. ikiwiki can run as a Subversion [[post-commit]] hook, so -that each committed change to your wiki is immediatly compiled and -published. +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. [[WhyIkiWiki]] -might be useful if you're considering using this. +Alternatively, think of ikiwiki as a particularly flexible static +site generator with some dynamic features. -[[Subversion]] also offers a way to let others edit pages on your wiki. -Just configure subversion to let appropriate users (or everyone) commit to -the wiki's repository. There are some things you should keep in mind about -[[Security]] when allowing the world to edit your ikiwiki. -[[Setup]] has a tutorial for setting up ikiwki. -[[TODO]] lists things that need to be added to ikiwiki before most people -would consider it a full-fledged wiki. +## 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]]. -All wikis are supposed to have a [[SandBox]], so this one does to. -ikiwiki is developed by [[Joey]].