Mercurial > wikked
comparison docs/pages/00__index.md @ 382:3a61f45702cb
docs: Add documentation site.
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Sun, 04 Oct 2015 08:02:43 -0700 |
| parents | |
| children | dcaa41b39c23 |
comparison
equal
deleted
inserted
replaced
| 381:d5511d832af3 | 382:3a61f45702cb |
|---|---|
| 1 --- | |
| 2 title: Wikked | |
| 3 icon: home | |
| 4 --- | |
| 5 | |
| 6 **Wikked** is a [wiki][] engine that stores its data in plain text files using | |
| 7 a common revision control system like [Mercurial][] or [Git][]. It's mostly | |
| 8 suitable for an individual, family, or small team. | |
| 9 | |
| 10 The source code is available on [Github][] and [BitBucket][]. | |
| 11 | |
| 12 ## Quickstart | |
| 13 | |
| 14 Install **Wikked** using Python 3.4 or later and `pip`: | |
| 15 | |
| 16 pip install wikked | |
| 17 | |
| 18 Let's create a new wiki: | |
| 19 | |
| 20 wk init mywiki | |
| 21 | |
| 22 This will create a new directory called `mywiki` with some basic files in it. It | |
| 23 will also initialize a [Mercurial][] repository in it. | |
| 24 | |
| 25 Now let's get in there and run it: | |
| 26 | |
| 27 cd mywiki | |
| 28 wk runserver | |
| 29 | |
| 30 You should now be able to open your favorite web browser and go to | |
| 31 `localhost:5000`. If you see the main page of your wiki, congratulations! | |
| 32 Otherwise, something went wrong. If you found a bug make sure to [file a | |
| 33 report][1] about it. | |
| 34 | |
| 35 | |
| 36 [wiki]: https://en.wikipedia.org/wiki/Wiki | |
| 37 [git]: http://git-scm.com/ | |
| 38 [mercurial]: http://mercurial.selenic.com/ | |
| 39 [github]: https://github.com/ludovicchabant/Wikked | |
| 40 [bitbucket]: https://bitbucket.org/ludovicchabant/wikked | |
| 41 [1]: https://github.com/ludovicchabant/Wikked/issues | |
| 42 | |
| 43 |