yyiki

A git-based wiki written in Python. Create/Clone a git repository into FLATPAGES_ROOT directory and create markdown files. Because the wiki pages are simply markdown files, you can use other tools such as Obsidian.

Design principles

yyiki is designed as a personal wiki software and simplicity is the primary principle.

• Markdown: yyiki only supports markdown, which is probably the most widely used, versatile, and simple document format.
• Git and flatfiles: yyiki is also a git repository. This removes the complexity of database and makes back-up straightforward. It also opens up the possibility of using other offline apps (e.g. Obsidian).
• Python (https://xkcd.com/353/) + Flaks + Flask-FlatPages allows concise code.

Installation

1. copy settings_template.py to settings.py.
2. copy templates/layout_template.html to templates/layout.html
3. put hashed admin password into hashed_admin_password.dat.
4. run poetry shell and poetry install