]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/index.mdwn
Merge commit 'upstream/master'
[git.ikiwiki.info.git] / doc / index.mdwn
index a4b2794332d1176d7e1c65ec2b4258a1d12b13df..93526c42ce5ced330645b4096e81185c025ba063 100644 (file)
@@ -1,22 +1,27 @@
-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
 
 
-[[Setup]] has a tutorial for setting up ikiwki.
+[[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]].
 
 
-[[TODO]] lists things that need to be added to ikiwiki before most people
-would consider it a full-fledged wiki.
+All wikis are supposed to have a [[SandBox]], so this one does too.
 
 
-All wikis are supposed to have a [[SandBox]], so this one does to.
+This site generally runs the latest release of ikiwiki; currently, it runs
+ikiwiki [[!version ]].
 
 
-ikiwiki is developed by [[Joey]].
+## 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]].