]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/index.mdwn
web commit by ThomasSchwinge: Initial version.
[ikiwiki.git] / doc / index.mdwn
index b873711f667f0b96fa112ffebb200dd6537b0fcf..8b7e7495977c848c89cd268c887ee718a207ebe4 100644 (file)
@@ -1,33 +1,17 @@
-ikiwiki is a wiki compiler. It converts a directory full of wiki pages
+[[ikiwiki_logo|logo/ikiwiki.png]]  
+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. 
+wiki, ikiwiki does not have its own means of storing page history or its own
+markup language. Instead it uses [[Subversion]] and [[MarkDown]].
 
-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.
+* See [[Features]] for a list of ikiwiki's features. [[RoadMap]], [[TODO]] and [[bugs]] might also be of interest.
 
-[[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.
+* [[Setup]] has a tutorial for setting up ikiwki, and [[Usage]] documents the parameters and usage of the ikiwiki program. If you use ikiwiki, please add your wiki to [[IkiWikiUsers]].
 
-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.
+* [[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.
 
-[[Setup]] has a tutorial for setting up ikiwki.
+All wikis are supposed to have a [[SandBox]], so this one does too.
 
-[[TODO]] lists things that need to be added to ikiwiki before most people
-would consider it a full-fledged wiki.
-
-All wikis are supposed to have a [[SandBox]], so this one does to.
-
-ikiwiki is developed by [[Joey]].
+ikiwiki is developed by [[Joey]] and is [[FreeSoftware]].