Blame
|
1 | ## Welcome |
||||||
|
2 | |||||||
|
3 | > [!NOTE] |
||||||
| 4 | > *First of all, there are no otters here. I'm utterly sorry about that. When I started this project, the name was given by the decision to write an otter wiki. |
|||||||
|
5 | > -- Ralph* |
||||||
|
6 | |||||||
|
7 | This is the home of **An Otter Wiki**. A minimalistic wiki powered by python, markdown and git. |
||||||
|
8 | |||||||
|
9 | ### Notable Features |
||||||
|
10 | |||||||
|
11 | - Minimalistic interface with dark-mode |
||||||
| 12 | - Editor with markdown support including tables |
|||||||
| 13 | - Full changelog and page history |
|||||||
|
14 | - Customizable Sidebar: Menu and/or Page Index |
||||||
|
15 | - User authentication |
||||||
| 16 | - Page Attachments |
|||||||
|
17 | - Extended Markdown: tables, footnotes, fancy blocks, alerts and mermaid diagrams. |
||||||
| 18 | - (experimental) Git http server: clone, pull and push the content of your wiki. |
|||||||
| 19 | - A very cute Otter as logo (drawn by [Christy Presler](http://christypresler.com/) CC BY 3.0) |
|||||||
|
20 | |||||||
| 21 | ### Demo |
|||||||
| 22 | ||||||||
|
23 | - Want to try it out yourself? Please check out the [Demo](http://demo.otterwiki.com). |
||||||
|
24 | - Looking for [[Examples|examples]] how to use An Otter Wiki? You came to the right place. Various examples on how to use this wiki can be found [[here|examples]]. |
||||||
| 25 | ||||||||
| 26 | ### Installation |
|||||||
| 27 | ||||||||
|
28 | Please read the [installation guide](/Installation) to get started, proceed to the [configuration guide](/Configuration). |
||||||
|
29 | |||||||
| 30 | ### Contributing |
|||||||
| 31 | ||||||||
|
32 | Thank you for considering to contribute to An Otter Wiki! If you ran into an issue or want to request a feature, please reach out via <i class="fab fa-github"></i> [github](https://github.com/redimp/otterwiki/issues). Or fork the [repository](https://github.com/redimp/otterwiki/) develop the feature and submit a pull request. Detailed instructions about setting up a development environment can be found in [[Development]]. |
||||||
|
33 | |||||||
| 34 | ### Licence |
|||||||
| 35 | ||||||||
| 36 | An Otter Wiki is open-source software licensed under the [MIT License](/-/about). |
|||||||