]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/index.mdwn
response
[git.ikiwiki.info.git] / doc / index.mdwn
index 00a8badf6e6da00b1f17df4b9edf48c1de9b55f9..22709f88d436635903a6ce80f5efab2b4113cfe6 100644 (file)
@@ -1,40 +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. 
-
-Why call it IkiWiki? Well, partly because I'm sure some people will find
-this a pretty Iky Wiki, since it's so different from other Wikis. Partly
-because "ikiwiki" is a nice palindrome. Partly because its design turns
-the usual design for a Wiki inside-out and backwards.
-
-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.) 
-
-[[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.
-
-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]].
-
-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.
-
-[[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 [[JoeyHess]].
+[[ikiwiki_logo|logo/ikiwiki.png]]  
+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]].
+
+* [[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 list of ikiwiki's features and [[plugins]] for information about its plugins. [[RoadMap]], [[TODO]]
+  and [[bugs]] might also be of interest. 
+
+* Feel free to post your questions and thoughts about ikiwiki to [[Discussion]].
+
+[[template id=note text="""
+If you use ikiwiki, please list your wiki in [[IkiWikiUsers]].
+Thanks! --[[Joey]]
+"""]]
+
+* [[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.
+
+* [[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.
+
+* Developers, please document any ikiwiki patches you have in the
+  [[PatchQueue]].
+
+All wikis are supposed to have a [[SandBox]], so this one does too.
+
+ikiwiki is developed by [[Joey]] and is [[FreeSoftware]].