]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/index.mdwn
* Switched to Text::Markdown. Thanks a lot!
[git.ikiwiki.info.git] / doc / index.mdwn
index 51a1f094b01b05f637c2ed4995fdbbeaaea046f8..93526c42ce5ced330645b4096e81185c025ba063 100644 (file)
@@ -1,19 +1,27 @@
-Welcome to the ikiwiki documentation wiki.
+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]].
 
-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 or its own
-markup language. Instead it uses [[Subversion]] and [[MarkDown]].
+[[!template id=links]]
 
-* [[News]] is a blog (built using ikiwiki) of news items about ikiwiki.
-  Yes, it's free software, yes you can [[Download]] it.
+## using ikiwiki
 
-* See [[Features]] for a current list of ikiwiki's features. [[TODO]] and [[bugs]] might also be of interest.
+[[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]].
 
-* [[Setup]] has a tutorial for setting up ikiwki, and [[Usage]] documents the parameters and usage of the ikiwiki program.
+All wikis are supposed to have a [[SandBox]], so this one does too.
 
-* [[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.
+This site generally runs the latest release of ikiwiki; currently, it runs
+ikiwiki [[!version ]].
 
-All wikis are supposed to have a [[SandBox]], so this one does too.
+## 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]].
+ikiwiki is developed by [[Joey]] and many contributors,
+and is [[FreeSoftware]].