]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/index.mdwn
fix
[ikiwiki.git] / doc / index.mdwn
index b873711f667f0b96fa112ffebb200dd6537b0fcf..18018b22308fd1234522c16ecdf2f5a627181b8f 100644 (file)
@@ -1,33 +1,37 @@
-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. Ikiwiki stores
+pages and hostory in a revision control system such as [[Subversion]]
+or [[Git]]. There are many other [[features]], including support for
+[[blogging|blog]], as well as a large array of [[plugins]].
 
-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.
+[[template id=note text="""
+[[ikiwiki_logo|logo/ikiwiki.png]]
 
-See [[Features]] for a current list of ikiwiki's features. [[WhyIkiWiki]]
-might be useful if you're considering using this.
+Quick links:
 
-[[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.
+* [[News]]
+* [[Download]]
+* [[Setup]]
+* [[Usage]]
+* [[Security]]
+* [[IkiWikiUsers]]
+* [[Contact]]
 
-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 ikiwki.
+### users
 
-[[TODO]] lists things that need to be added to ikiwiki before most people
-would consider it a full-fledged wiki.
+[[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, and some [[tips]].
 
-All wikis are supposed to have a [[SandBox]], so this one does to.
+All wikis are supposed to have a [[SandBox]], so this one does too.
 
-ikiwiki is developed by [[Joey]].
+## developers
+
+The [[RoadMap]] describes where the project is going.
+[[Bugs]], [[TODO]] items, [[wishlist]] items, and [[patches]]
+can be submitted and tracked using this wiki.
+
+ikiwiki is developed by [[Joey]] and many contributors,
+and is [[FreeSoftware]].