git.cworth.org Git - ikiwiki-bootstrap/blob - README

   1 This is a simple set of files for bootstrapping a git-backed instance
   2 of ikiwiki.
   3
   4 I put this together to make it easier to get started with ikiwiki than
   5 following the standad instructions:
   6
   7         http://ikiwiki.info/setup/
   8
   9 Features
  10 ========
  11 Here are some of the key features of what I've got setup:
  12
  13 1. Self-contained.
  14
  15         The ikiwiki configuration file, the templates, and source
  16         files are all together in one repository.
  17
  18 2. Minimal
  19
  20         The default ikiwiki setup instructions would pull in a bunch
  21         of "stock" wiki pages and some underlay content. This setup
  22         saves you the hassle of having to prune any of that out.
  23
  24 3. Pre-configured for git
  25
  26         Most of the git-specific settings you need are already setup
  27         in ikiwiki.setup.
  28
  29 Usage
  30 =====
  31 To start choose where the bare git repository will exist on your web
  32 server and where you'd like the HTML results to be published to. Edit
  33 ikiwiki.setup and fill these in for gitrepo and destdir.
  34
  35 Next, follow these steps to setup gitrepo along with a nested checkout
  36 inside of it that ikiwiki will use:
  37
  38         mkdir -p $gitrepo
  39         cd $gitrepo
  40         GIT_DIR=. git init-db
  41         git clone $gitrepo ikiwiki-checkout
  42
  43 Finally, push this repository out to $gitrepo, then start adding
  44 content in files under src.
  45
  46 Let me know if you have any problems or questions,
  47
  48 Carl Worth <cworth@cworth.org>