## Welcome

> [!NOTE]
>  *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.
> -- Ralph*

This is the home of **An Otter Wiki**. A minimalistic wiki powered by python, markdown and git.

### Notable Features

- Minimalistic interface with dark-mode support
- Editor with tools for convenient markdown editing
- Upload and attach files to pages or paste images directly in the editor
- Version tracking allows to compare revisions and revert changes
- User authentication with self-registration and password recovery
- Extended Markdown: tables, footnotes, fancy blocks, alerts and mermaid diagrams
- Customizable Sidebar: Create a menu and/or display a page index
- (experimental) Git http server: clone, pull and push the content of your wiki
- A very cute Otter as logo (drawn and released by [Christy Presler](https://christypresler.com/) under CC BY 3.0)

### Try It Out

* Want to see An Otter Wiki in action? Check out our live [Demo](https://demo.otterwiki.com).
* Looking for examples on how to use this wiki? You're in luck! We have a collection of [Examples](/examples) that demonstrate its capabilities.

### Getting Started

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).

### Contributing

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).

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.

### Licence

An Otter Wiki is open-source software licensed under the [MIT License](/-/about).
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9