X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/198c2d9c45cb974aabf999797bdb7d6ab8636b2c..30f7aef67902cbb04d35854e01be21c29ba2de0d:/doc/index.mdwn diff --git a/doc/index.mdwn b/doc/index.mdwn index 00a8badf6..9d1110772 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,40 +1,24 @@ -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 history 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]]. -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. +[[template id=links]] -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.) +## using ikiwiki -[[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 ikiwiki, or you can read the +[[man_page|usage]]. There are some [[examples]] of things you can do + with ikiwiki, and some [[tips]]. -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]]. +All wikis are supposed to have a [[SandBox]], so this one does too. -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. +## developer resources -[[TODO]] lists things that need to be added to ikiwiki before most people -would consider it a full-fledged wiki. +The [[RoadMap]] describes where the project is going. +[[Bugs]], [[TODO]] items, [[wishlist]] items, and [[patches|patch]] +can be submitted and tracked using this wiki. -All wikis are supposed to have a [[SandBox]], so this one does to. - -ikiwiki is developed by [[JoeyHess]]. +ikiwiki is developed by [[Joey]] and many contributors, +and is [[FreeSoftware]].