]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/index.mdwn
fix
[ikiwiki.git] / doc / index.mdwn
index 51b6f34819e8d3f4b0f14e91aef274aa787b1f05..18018b22308fd1234522c16ecdf2f5a627181b8f 100644 (file)
@@ -1,18 +1,37 @@
-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 hostory in a revision control system such as [[Subversion]]
+or [[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=note text="""
+[[ikiwiki_logo|logo/ikiwiki.png]]
 
-* See [[Features]] for a current list of ikiwiki's features. [[TODO]] and [[bugs]] might also be of interest.
+Quick links:
 
-* [[Setup]] has a tutorial for setting up ikiwki, and [[Usage]] documents the parameters and usage of the ikiwiki program.
+* [[News]]
+* [[Download]]
+* [[Setup]]
+* [[Usage]]
+* [[Security]]
+* [[IkiWikiUsers]]
+* [[Contact]]
 
-* [[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.
+"""]]
 
-Ikiwiki is _not_ yet formally released, although it's very close to being ready for a release now. If you really have to have it: `svn://svn.kitenet.net/ikiwiki/trunk`
+### users
+
+[[Setup]] has a tutorial for setting up ikiwiki, and [[Usage]] documents
+the parameters and usage of the ikiwiki program. There are some
+[[examples]] of things you can do with ikiwiki, and some [[tips]].
 
 All wikis are supposed to have a [[SandBox]], so this one does too.
 
-ikiwiki is developed by [[Joey]].
+## developers
+
+The [[RoadMap]] describes where the project is going.
+[[Bugs]], [[TODO]] items, [[wishlist]] items, and [[patches]]
+can be submitted and tracked using this wiki.
+
+ikiwiki is developed by [[Joey]] and many contributors,
+and is [[FreeSoftware]].