]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/index.mdwn
correct documentation about scan hook (which has never existed)
[git.ikiwiki.info.git] / doc / index.mdwn
index 867111b51a3936355380cb5e1563af52dbde3018..357081fa4c44c1d140df671106b5da95e6df60eb 100644 (file)
@@ -1,20 +1,36 @@
-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]].
+ikiwiki is a **wiki compiler**. It converts wiki pages
+into HTML pages suitable for publishing on a website. Unlike many
+wikis, ikiwiki does not have its own ad-hoc means of storing page history,
+and instead uses a revision control system such as [[Subversion]].
 
-* See [[Features]] for a current list of ikiwiki's features. 
+* [[News]] is a blog (built using ikiwiki) of news items about ikiwiki.
+  It's the best way to find out when there's a new version to [[Download]].
 
-* [[WhyIkiWiki]] might be useful if you're considering using this.
+* Ikiwiki has a nice set of wiki [[features]] which can be expanded by
+  a large array of [[plugins]]. It also has some [[bugs]], a [[TODO]] list,
+  and a [[RoadMap]].
 
-* [[Setup]] has a tutorial for setting up ikiwki.
+[[template id=note text="""
+[[ikiwiki_logo|logo/ikiwiki.png]]  
+[[news/Version_2.00]] is now available.  
+If you use ikiwiki, please list your wiki in [[IkiWikiUsers]].
+Thanks! --[[Joey]]
+"""]]
 
-* [[TODO]] and bugs lists things that need to be added to ikiwiki before most people would consider it a full-fledged wiki.
+* [[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.
 
-* [[Security]] lists potential security problems. ikiwiki is still being developed, and is being written with security as a priority, don't expect things to stay in this list for long.
+* Feel free to post your questions and thoughts about ikiwiki to
+  [[Discussion]], or [[contact]] the developers.
 
-Ikiwiki is _not_ yet formally realeased. If you really have to have it, <svn://svn.kitenet.net/ikiwiki/trunk>
+* [[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 to.
+* Developers, please document any ikiwiki patches you have in the
+  [[PatchQueue]].
 
-ikiwiki is developed by [[Joey]].
+All wikis are supposed to have a [[SandBox]], so this one does too.
+
+ikiwiki is developed by [[Joey]] and is [[FreeSoftware]].