Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/redimp/otterwiki

A minimalistic wiki powered by python, markdown and git.
https://github.com/redimp/otterwiki

git markdown wiki

Last synced: about 1 month ago
JSON representation

A minimalistic wiki powered by python, markdown and git.

Host: GitHub
URL: https://github.com/redimp/otterwiki
Owner: redimp
License: mit
Created: 2018-07-04T21:21:40.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-10-27T12:21:08.000Z (about 2 months ago)
Last Synced: 2024-10-27T13:55:51.838Z (about 2 months ago)
Topics: git, markdown, wiki
Language: Python
Homepage: https://otterwiki.com
Size: 6.62 MB
Stars: 514
Watchers: 6
Forks: 26
Open Issues: 20
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

project-awesome - redimp/otterwiki - A minimalistic wiki powered by python, markdown and git. (Python)
awesome-starred - redimp/otterwiki - An Otter Wiki is Python-based software for collaborative content management, called a wiki. The content is stored in a git repository, which keeps track of all changes. Markdown is used as markup lang (python)

README

        ![](screenshot.png)

# An Otter Wiki

An Otter Wiki is Python-based software for collaborative content

management, called a [wiki](https://en.wikipedia.org/wiki/Wiki). The

content is stored in a git repository, which keeps track of all changes.

[Markdown](https://daringfireball.net/projects/markdown) is used as

Markup language. An Otter Wiki is written in [python](https://www.python.org/)

using the microframework [Flask](http://flask.pocoo.org/).

[halfmoon](https://www.gethalfmoon.com) is used as CSS framework

and [CodeMirror](https://codemirror.net/) as editor.

[Font Awesome Free](https://fontawesome.com/license/free) serves the icons.

## Notable Features

- Minimalistic interface (with dark-mode)

- Editor with markdown highlighting and support including tables

- Customizable Sidebar: Menu and/or Page Index

- Full changelog and page history

- User authentication

- Page Attachments

- Extended Markdown: tables, footnotes, fancy blocks, alerts and mermaid diagrams

- (experimental) Git http server: clone, pull and push the content of your wiki

- A very cute Otter as logo (drawn by [Christy Presler](http://christypresler.com/) CC BY 3.0)

## Demo

Check out the demo .

## Installation

Read the [installation guide](https://otterwiki.com/Installation) to get

started. Recommended is the installation with `docker-compose`.

### Quick start with docker-compose

1. Copy and edit the `docker-compose.yml` below to match your preferences.

2. Run `docker-compose up -d`

3. Access the wiki via http://127.0.0.1:8080 if run on your machine.

4. If the wiki shall be accessible via the internet and an domain name make sure to configure your web server accordingly. Check the [installation guide](https://otterwiki.com/Installation#reverse-proxy) for example configurations for nginx, apache and caddy.

5. Register your account. The first account is an admin-account giving you access to the settings tab.

6. Customize the settings to your liking.

Proceed for the [configuration guide](https://otterwiki.com/Configuration) for

detailed information.

#### docker-compose.yml

```yaml

services:

  otterwiki:

    image: redimp/otterwiki:2

    restart: unless-stopped

    ports:

      - 8080:80

    volumes:

      - ./app-data:/app-data

```

## License

An Otter Wiki is open-source software licensed under the [MIT License](https://github.com/redimp/otterwiki/blob/main/LICENSE).

[modeline]: # ( vim: set fenc=utf-8 spell spl=en sts=4 et tw=72: )