try

[ikiwiki.git] / doc / index.mdwn

diff --git a/doc/index.mdwn b/doc/index.mdwn
index 327e685afd8c5f8be9bbfd4cccf1caa694b64045..b4543f1aeb908cb2314cbf24c1fb2a960eb72127 100644 (file)
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -1,36 +1,33 @@
-[[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. (It can also be run by hand, by cron, or integrated with any
-other revision control system.) 
+[[template id=note text="""
+[[ikiwiki_logo|logo/ikiwiki.png]]  
+[[News]]  
+[[Download]]  
+[[Setup]]  
+[[Usage]]  
+[[Security]]  
+[[Users|IkiWikiUsers]]  
+[[Contact]]  
+"""]]
 
-[[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.
+### using ikiwiki
 
-ikiwiki supports pages using [[MarkDown]] as their markup language. Any
-page with a filename ending in ".mdwn" is converted from markdown to html
-by ikiwiki. Markdown understands text formatted as it would be in an email,
-and is quite smart about converting it to html. The only additional markup
-provided by ikiwiki aside from regular markdown is the [[WikiLink]].
+[[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]].
 
-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.
+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.
+### developer resources
 
-All wikis are supposed to have a [[SandBox]], so this one does to.
-If you'd like to try editing pages on this wiki, do whatever you'd like in 
+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 JoeyHess.
+ikiwiki is developed by [[Joey]] and many contributors,
+and is [[FreeSoftware]].