3.20161229.1~bpo8+1

[git.ikiwiki.info.git] / doc / index.mdwn

diff --git a/doc/index.mdwn b/doc/index.mdwn
index a14be5401a5d35658f85aa846f3528ecb347e3b3..e0e40165673a71f5d906a349157e4d7426d6f489 100644 (file)
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -1,20 +1,37 @@
-Welcome to the ikiwiki documentation wiki.
+[[!template id=links]]

 
 

-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. 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]].

 
 

-* [[News]] is a blog (built using ikiwiki) of new items about ikiwiki.
+Alternatively, think of ikiwiki as a particularly flexible static
+site generator with some dynamic features.

 
 

-* 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.
+## using ikiwiki

 
 

-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`
+[[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.
+
+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]].