Blame
|
1 | ## Welcome |
||||||
|
2 | |||||||
|
3 | This is the home of **An Otter Wiki**[^1], a minimalistic wiki powered by python, markdown and git. |
||||||
|
4 | |||||||
|
5 | ### Notable Features |
||||||
|
6 | |||||||
|
7 | - Minimalistic interface with dark-mode support |
||||||
|
8 | - Editor with tools for convenient markdown editing |
||||||
|
9 | - Upload and attach files to pages, paste images directly in the editor |
||||||
| 10 | - [[Extended Markdown|Examples/All Syntax Features]]: tables, footnotes, fancy blocks, alerts, formulas and mermaid diagrams |
|||||||
|
11 | - (experimental) Embeddings: [AttachmentList](/Examples/AttachmentList), [DataTable](/Examples/DataTable), [Figure](/Examples/Figure), [ImageFrame](/Examples/ImageFrame), [Include](/Examples/Include), [InfoBox](/Examples/InfoBox), [PageIndex](/Examples/PageIndex) and [Video](/Examples/Video%20Attachment) |
||||||
| 12 | - Git backend: full changelog and page history, optional [[Git Web Server|Configuration/Repository%20Management]] |
|||||||
|
13 | - User authentication with self-registration and password recovery |
||||||
|
14 | - A very cute otter as our logo (drawn and released by [Christy Presler](https://christypresler.com/) under CC BY 3.0) |
||||||
|
15 | |||||||
|
16 | ### Demo |
||||||
|
17 | |||||||
|
18 | - Want to see An Otter Wiki in action? Check out our live [Demo](https://demo.otterwiki.com). |
||||||
| 19 | - See the [Examples](/Examples) for working samples of every syntax feature and embedding. |
|||||||
|
20 | |||||||
|
21 | ### Getting Started |
||||||
|
22 | |||||||
|
23 | 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). |
||||||
|
24 | |||||||
| 25 | ### Contributing |
|||||||
| 26 | ||||||||
|
27 | Thank you for considering contributing to An Otter Wiki! If you run 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). |
||||||
|
28 | |||||||
|
29 | 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. |
||||||
|
30 | |||||||
|
31 | ### License |
||||||
|
32 | |||||||
| 33 | An Otter Wiki is open-source software licensed under the [MIT License](/-/about). |
|||||||
|
34 | |||||||
| 35 | [^1]: There are no otters here. I'm utterly sorry about that. When I started this project, the name came from the spontaneous decision to write an otter wiki. – [Ralph](https://github.com/redimp) |
|||||||
