X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/58fafcea44f213dcff1789b04205a616a84e63a8..6d7848829174f0d472d508e75c4f5d9b8af69d13:/doc/index.mdwn?ds=sidebyside diff --git a/doc/index.mdwn b/doc/index.mdwn index b873711f6..4c22ce0e0 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,33 +1,29 @@ -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. +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]], as well as a large array of [[plugins]]. -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. +[[!template id=links]] -See [[Features]] for a current list of ikiwiki's features. [[WhyIkiWiki]] -might be useful if you're considering using this. +## using ikiwiki -[[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 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. -ikiwiki also supports files of any other type, including raw html, text, -images, etc. These are not converted to wiki pages, they are just copied -unchanged by ikiwiki as it builds your wiki. So you can check in an image, -program, or other special file and link to it from your wiki pages. -ikiwiki also supports making one page that is a [[SubPage]] of another. +All wikis are supposed to have a [[sandbox]], so this one does too. -[[Setup]] has a tutorial for setting up ikiwki. +This site generally runs the latest release of ikiwiki; currently, it runs +ikiwiki [[!version ]]. -[[TODO]] lists things that need to be added to ikiwiki before most people -would consider it a full-fledged wiki. +## developer resources -All wikis are supposed to have a [[SandBox]], so this one does to. +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]]. +Ikiwiki is developed by [[Joey]] and many contributors, +and is [[FreeSoftware]].