]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/index.mdwn
fix
[git.ikiwiki.info.git] / doc / index.mdwn
index b873711f667f0b96fa112ffebb200dd6537b0fcf..6a98515178c3146c1b0885d383a0d1e41713ec75 100644 (file)
@@ -1,33 +1,35 @@
-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, its own
-markup language, or support for editing pages online. 
+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]].
 
-To use ikiwiki to set up a wiki, you will probably want to use it with a
-revision control system, such as [[Subversion]], for keeping track of past
-versions of pages. ikiwiki can run as a Subversion [[post-commit]] hook, so
-that each committed change to your wiki is immediatly compiled and
-published.
+* [[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]].
 
-See [[Features]] for a current list of ikiwiki's features. [[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]].
 
-[[Subversion]] also offers a way to let others edit pages on your wiki.
-Just configure subversion to let appropriate users (or everyone) commit to
-the wiki's repository. There are some things you should keep in mind about
-[[Security]] when allowing the world to edit your ikiwiki.
+[[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]]
+"""]]
 
-ikiwiki also supports files of any other type, including raw html, text,
-images, etc. These are not converted to wiki pages, they are just copied
-unchanged by ikiwiki as it builds your wiki. So you can check in an image,
-program, or other special file and link to it from your wiki pages.
-ikiwiki also supports making one page that is a [[SubPage]] of another.
+* [[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.
 
-[[Setup]] has a tutorial for setting up ikiwki.
+* This wiki is used for tracking ikiwiki's [[TODO]] items, [[bugs]],
+  [[patches|patch]], and its general [[RoadMap]].
 
-[[TODO]] lists things that need to be added to ikiwiki before most people
-would consider it a full-fledged wiki.
+* Feel free to post your questions and thoughts about ikiwiki to
+  [[Discussion]], or [[contact]] the developers.
 
-All wikis are supposed to have a [[SandBox]], so this one does to.
+* [[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.
 
-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]].