https://github.com/wikkid-team/wikkid
A vcs-backed wiki
https://github.com/wikkid-team/wikkid
bzr git wiki
Last synced: 3 months ago
JSON representation
A vcs-backed wiki
- Host: GitHub
- URL: https://github.com/wikkid-team/wikkid
- Owner: wikkid-team
- License: agpl-3.0
- Created: 2021-10-30T16:55:41.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-02-21T01:09:40.000Z (4 months ago)
- Last Synced: 2026-02-21T07:09:40.572Z (4 months ago)
- Topics: bzr, git, wiki
- Language: Python
- Homepage:
- Size: 4.32 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: Changes.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
================
Wikkid Wiki Home
================
Wikkid is a wiki that uses Git or Bazaar as a way to store the content.
By default, it uses ``rest`` (restructuredText) as the file format
for wiki page, but it can also be configured to use ``markdown``
or ``textile``.
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
.. _Bazaar: https://bazaar.canonical.com
.. _Git: https://git-scm.com/
.. _Python: https://python.org
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/
To see what options are available, run::
$ wikkid-serve --help
Now what?
---------
* Read the hacking_ document
* Browse the source
* Look through the `To Do`_ list and fix something
.. _hacking: Hacking.txt
.. _`To Do`: ToDo.txt