X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/eb13d46e212d893a68a6a3739a421e3e24ed7c1b..1f8b0460c309c54cfbfe4152bbc195a1756cbda5:/doc/setup.mdwn diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 7f3f6840d..174d6ceb9 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -1,9 +1,12 @@ This tutorial will walk you through setting up a wiki with ikiwiki. -[[toc ]] +[[!toc ]] ## [[Download]] and [[install]] ikiwiki. +If you're using Debian or Ubuntu, ikiwiki is an `apt-get install ikiwiki` away. +If you're not, see the [[download]] and [[install]] pages. + ## Decide where your wiki's files will go. As a wiki compiler, ikiwiki builds a wiki from files in a source directory, @@ -29,8 +32,8 @@ This will create a simple main page for the wiki. $EDITOR index.mdwn In the editor, you could start by entering a simple page like -[[toggle id=page text="this one"]]. -[[toggleable id=page text=""" +[[!toggle id=page text="this one"]]. +[[!toggleable id=page text=""" Welcome to your new wiki. All wikis are supposed to have a \[[SandBox]], @@ -113,14 +116,14 @@ should be preserved, but not checked into revision control. The new [[ikiwiki-makerepo]] command automates setting up a wiki in revision control. -[[toggle id=subversion text="Subversion"]] -[[toggleable id=subversion text=""" +[[!toggle id=subversion text="Subversion"]] +[[!toggleable id=subversion text=""" REPOSITORY=~/wikirepo ikiwiki-makerepo svn $SRCDIR $REPOSITORY """]] -[[toggle id=git text="Git"]] -[[toggleable id=git text=""" +[[!toggle id=git text="Git"]] +[[!toggleable id=git text=""" REPOSITORY=~/wiki.git ikiwiki-makerepo git $SRCDIR $REPOSITORY @@ -129,20 +132,20 @@ ikiwiki uses git repositories, and some important caveats about using the git repositories. """]] -[[toggle id=mercurial text="Mercurial"]] -[[toggleable id=mercurial text=""" +[[!toggle id=mercurial text="Mercurial"]] +[[!toggleable id=mercurial text=""" REPOSITORY=$SRCDIR ikiwiki-makerepo mercurial $SRCDIR """]] -[[toggle id=bazaar text="Bazaar"]] -[[toggleable id=bazaar text=""" +[[!toggle id=bazaar text="Bazaar"]] +[[!toggleable id=bazaar text=""" REPOSITORY=$SRCDIR ikiwiki-makerepo bzr $SRCDIR """]] -[[toggle id=tla text="TLA"]] -[[toggleable id=tla text=""" +[[!toggle id=tla text="TLA"]] +[[!toggleable id=tla text=""" REPOSITORY=~/wikirepo tla make-archive me@localhost--wiki $REPOSITORY tla my-id "" @@ -155,8 +158,8 @@ about using the git repositories. tla import """]] -[[toggle id=monotone text="Monotone"]] -[[toggleable id=monotone text=""" +[[!toggle id=monotone text="Monotone"]] +[[!toggleable id=monotone text=""" # These instructions are standard instructions to import a directory into monotone # and set it up so that you don't need any passwords to use it REPOSITORY=~/.ikiwiki/mtn.db @@ -186,7 +189,8 @@ about using the git repositories. Once your wiki is checked in to the revision control system, you should configure ikiwiki to use revision control. Edit your ikiwiki.setup, and uncomment the lines for the revision control system -you chose to use. Uncomment the block for the wrapper for your revision +you chose to use. Be sure to set `svnrepo` to $REPOSITORY, if using +subversion. Uncomment the block for the wrapper for your revision control system, and configure the wrapper path in that block appropriately (for Git, it should be `$REPOSITORY/hooks/post-update`).