]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/index.mdwn
close
[git.ikiwiki.info.git] / doc / index.mdwn
index 6a98515178c3146c1b0885d383a0d1e41713ec75..e0e40165673a71f5d906a349157e4d7426d6f489 100644 (file)
@@ -1,35 +1,37 @@
-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]].
+[[!template id=links]]
 
-* [[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]].
+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]] and [[podcasting|podcast]], as well as a large
+array of [[plugins]].
 
-* Ikiwiki has a nice set of wiki [[features]] which can be expanded by
-  a large array of [[plugins]].
+Alternatively, think of ikiwiki as a particularly flexible static
+site generator with some dynamic features.
 
-[[template id=note text="""
-[[ikiwiki_logo|logo/ikiwiki.png]]  
-[[Version_2.0|news/ikiwiki_version_2.0]] is now available.  
-If you use ikiwiki, please list your wiki in [[IkiWikiUsers]].
-Thanks! --[[Joey]]
-"""]]
 
-* [[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.
 
-* This wiki is used for tracking ikiwiki's [[TODO]] items, [[bugs]],
-  [[patches|patch]], and its general [[RoadMap]].
+## using ikiwiki
 
-* Feel free to post your questions and thoughts about ikiwiki to
-  [[Discussion]], or [[contact]] the developers.
+[[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]].  Basic documentation for ikiwiki plugins
+and syntax is provided [[here|ikiwiki]]. The [[forum]] is open for
+discussions.
 
-* [[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.
+
+This site generally runs the latest release of ikiwiki; currently, it runs
+ikiwiki [[!version ]].
+
+## 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]].
 
-All wikis are supposed to have a [[SandBox]], so this one does too.
 
-ikiwiki is developed by [[Joey]] and is [[FreeSoftware]].