]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/index.mdwn
improve
[ikiwiki.git] / doc / index.mdwn
index a14be5401a5d35658f85aa846f3528ecb347e3b3..fc8ef769d4e5a655fc434196c5fb796a2497cf93 100644 (file)
@@ -1,20 +1,33 @@
-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]].
+
+[[template id=note text="""
+[[ikiwiki_logo|logo/ikiwiki.png]]  
+[[News]]  
+[[Download]]  
+[[Setup]]  
+[[Usage]]  
+[[Security]]  
+[[Users|IkiWikiUsers]]  
+[[Contact]]  
+"""]]
+
+### 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]].
 
-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]].
-
-* [[News]] is a blog (built using ikiwiki) of new items about 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 ikiwki, and [[Usage]] documents the parameters and usage of the ikiwiki program.
-
-* [[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.
+All wikis are supposed to have a [[SandBox]], so this one does too.
 
-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`
+### developer resources
 
-All wikis are supposed to have a [[SandBox]], so this one does too.
+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]].
+ikiwiki is developed by [[Joey]] and many contributors,
+and is [[FreeSoftware]].