diff options
| author | www-data <www-data@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2006-03-11 05:23:10 +0000 |
|---|---|---|
| committer | www-data <www-data@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2006-03-11 05:23:10 +0000 |
| commit | 58fafcea44f213dcff1789b04205a616a84e63a8 (patch) | |
| tree | a72a8188af8e07bcaefadac047ce9b964be82669 /doc/index.mdwn | |
| parent | 05327034a20a6306e2ec214009ccc5febb1227bc (diff) | |
web commit from 66.118.98.137:
Diffstat (limited to 'doc/index.mdwn')
| -rw-r--r-- | doc/index.mdwn | 16 |
1 files changed, 6 insertions, 10 deletions
diff --git a/doc/index.mdwn b/doc/index.mdwn index 2351f438a..b873711f6 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,26 +1,22 @@ -Ikiwiki is a wiki compiler. It converts a directory full of wiki pages +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. [[WhyIkiWiki]] +markup language, or support for editing pages online. 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.) +published. + +See [[Features]] for a current list of ikiwiki's features. [[WhyIkiWiki]] +might be useful if you're considering using this. [[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, |