]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/index.mdwn
Set Debian package maintainer to Simon McVittie as I'm retiring from Debian.
[git.ikiwiki.info.git] / doc / index.mdwn
index 10ff849517dbbc5feabcd2baf44bda0c68f50a9b..f4073aa98923436c186bc05fe59d05d9c653c9ef 100644 (file)
@@ -1,5 +1,33 @@
-# An elephant can die from a broken heart
+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]].
 
-It turns out that [elephants](http://www.omg-facts.com/Animals/An-Elephant-Can-Die-From-A-Broken-Heart/2937) are highly emotional animals. They form close-knit relationships with one another and mourn the loss of loved ones. At times, if a fellow elephant dies, the others in the herd will gather around and pay their respects as if at a funeral.
-If a baby elephant loses its mother, it will grieve. The elephant will often become withdrawn and emaciated. Other members of the herd will gather around and nurse the orphan back to life. Elephants can form deep attachments with humans too.
-In one case, an elephant handler raised a baby elephant. She had to go away for a brief time to attend her daughter’s wedding. When she returned, she found that the baby elephant had died of a broken heart at her absence.
+Alternatively, think of ikiwiki as a particularly flexible static
+site generator with some dynamic features.
+
+[[!template id=links]]
+
+## 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]].  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]].