]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/index.mdwn
* Add wikitext markup plugin, which supports ".wiki" pages written in the
[ikiwiki.git] / doc / index.mdwn
index 327e685afd8c5f8be9bbfd4cccf1caa694b64045..3191d1c24889893456280dfb307a7993cbacf3b1 100644 (file)
@@ -1,36 +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 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.
+Instead it can use [[Subversion]] (or [[Git]]).
 
-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.) 
+* [[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]].
 
-[[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.
+* See [[Features]] for a list of ikiwiki's features. [[RoadMap]], [[TODO]] and [[bugs]] might also be of interest. Feel free to post your thoughts about ikiwiki to [[Discussion]].
 
-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. 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.
 
-[[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 too.
 
-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 
-
-[[ikiwiki]] is developed by JoeyHess.
+ikiwiki is developed by [[Joey]] and is [[FreeSoftware]].