Skip to content

wikkid-team/wikkid

Repository files navigation

Wikkid Wiki Home

Wikkid is a wiki that uses Git or Bazaar as a way to store the content.

Principles of Wikkid

  • Will run using any Git or Bazaar branch, not just one it has created
  • Provides a Breezy plugin to simplify the serving of a branch
  • When run locally Wikkid will use the current users configured identity
  • Can be used as a public facing wiki with multiple users
  • Can be used as a library in other Python applications

Quickstart

To run from source, type something like:

$ python3 setup.py develop  # install dependencies
$ git init /tmp/wiki
$ ./bin/wikkid-serve /tmp/wiki
$ sensible-browser http://localhost:8080/

Or, using docker:

$ docker run -p 8080:8080 -v /path/to/some/repo:/data \
  ghcr.io/wikkid-team/wikkid
$ sensible-browser http://localhost:8080/

Now what?