Blame
| ef93d4 | Ralph Thesen | 2023-10-14 21:33:12 | 1 | ## Welcome |
| 06ae3d | Otterwiki Robot | 2023-10-14 21:17:14 | 2 | |
| d80fd1 | Ralph Thesen | 2024-10-19 10:27:29 | 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. |
|||
| d8cbee | Ralph Thesen | 2023-11-26 17:06:50 | 5 | > -- Ralph* |
| 06ae3d | Otterwiki Robot | 2023-10-14 21:17:14 | 6 | |
| c800b2 | Ralph Thesen | 2024-04-29 09:28:30 | 7 | This is the home of **An Otter Wiki**. A minimalistic wiki powered by python, markdown and git. |
| 06ae3d | Otterwiki Robot | 2023-10-14 21:17:14 | 8 | |
| d8cbee | Ralph Thesen | 2023-11-26 17:06:50 | 9 | ### Notable Features |
| 06ae3d | Otterwiki Robot | 2023-10-14 21:17:14 | 10 | |
| f0500f | Ralph Thesen | 2025-08-10 22:29:47 | 11 | - Minimalistic interface with dark-mode support |
| 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 and mermaid diagrams |
|||
| 17 | - Customizable Sidebar: Create a menu and/or display a page index |
|||
| 18 | - (experimental) Git http server: clone, pull and push the content of your wiki |
|||
| 19 | - A very cute Otter as logo (drawn and released by [Christy Presler](https://christypresler.com/) under CC BY 3.0) |
|||
| d8cbee | Ralph Thesen | 2023-11-26 17:06:50 | 20 | |
| f0500f | Ralph Thesen | 2025-08-10 22:29:47 | 21 | ### Try It Out |
| d8cbee | Ralph Thesen | 2023-11-26 17:06:50 | 22 | |
| f0500f | Ralph Thesen | 2025-08-10 22:29:47 | 23 | * Want to see An Otter Wiki in action? Check out our live [Demo](https://demo.otterwiki.com). |
| 24 | * Looking for examples on how to use this wiki? You're in luck! We have a collection of [Examples](/examples) that demonstrate its capabilities. |
|||
| d8cbee | Ralph Thesen | 2023-11-26 17:06:50 | 25 | |
| f0500f | Ralph Thesen | 2025-08-10 22:29:47 | 26 | ### Getting Started |
| d8cbee | Ralph Thesen | 2023-11-26 17:06:50 | 27 | |
| f0500f | Ralph Thesen | 2025-08-10 22:29:47 | 28 | 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). |
| d8cbee | Ralph Thesen | 2023-11-26 17:06:50 | 29 | |
| 30 | ### Contributing |
|||
| 31 | ||||
| f0500f | Ralph Thesen | 2025-08-10 22:29:47 | 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](/development). |
| 33 | ||||
| 34 | 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. |
|||
| d8cbee | Ralph Thesen | 2023-11-26 17:06:50 | 35 | |
| 36 | ### Licence |
|||
| 37 | ||||
| 38 | An Otter Wiki is open-source software licensed under the [MIT License](/-/about). |