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 support and customization options |
||||||
|
12 | - Editor with tools for convenient markdown editing |
||||||
| 13 | - Upload and attach files to pages or paste images directly in the editor |
|||||||
| 14 | - Version tracking allows to compare revisions and revert changes |
|||||||
| 15 | - User authentication with self-registration and password recovery |
|||||||
|
16 | - Extended Markdown: tables, footnotes, fancy blocks, alerts, formulas and mermaid diagrams |
||||||
|
17 | - Customizable Sidebar: Create a menu and/or display a page index |
||||||
|
18 | - (experimental) Repository management: Git Web Server, automatic pushes & pulls to/from a remote |
||||||
| 19 | - (experimental) Plugin support |
|||||||
|
20 | - A very cute Otter as logo (drawn and released by [Christy Presler](https://christypresler.com/) under CC BY 3.0) |
||||||
|
21 | |||||||
|
22 | ### Try It Out |
||||||
|
23 | |||||||
|
24 | * Want to see An Otter Wiki in action? Check out our live [Demo](https://demo.otterwiki.com). |
||||||
| 25 | * Looking for examples on how to use this wiki? You're in luck! We have a collection of [Examples](/examples) that demonstrate its capabilities. |
|||||||
|
26 | |||||||
|
27 | ### Getting Started |
||||||
|
28 | |||||||
|
29 | Ready to set up your own instance? Follow the [installation guide](/Installation) to set up your wiki. For detailed information about the configuration, consult our [configuration guide](/Configuration). |
||||||
|
30 | |||||||
| 31 | ### Contributing |
|||||||
| 32 | ||||||||
|
33 | 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](/development). |
||||||
| 34 | ||||||||
| 35 | Want to help improve this documentation? Found a typo, a missing section, or have an idea for a FAQ entry? We welcome your pull requests to the <i class="fab fa-github"></i> [otterwiki-documentation](https://github.com/redimp/otterwiki-documentation) repository. |
|||||||
|
36 | |||||||
| 37 | ### Licence |
|||||||
| 38 | ||||||||
| 39 | An Otter Wiki is open-source software licensed under the [MIT License](/-/about). |
|||||||