Wirikiki aims at being a productivity oriented markdown notebook. It's compatible with the most common features supported by GitHub's markdown and adds a few other.

Aims at

• fast / small footprint
• simplicity of use
• uncluttered UI supporting both dark & bright modes
• advanced markdown support via markItDown and plugins and Marked for the editor
• auto archival (using git)

Installation

Building

3 ways to get a runnable code:

• install a release (eg: using pip)
• make dev
• manual installation

sh ./makevueApps.sh
npm install
DIST=1 ./node_modules/.bin/rollup -c rollup.config.js

Usage

Create one wiki

wirikiki new myNewWiki

Run the wiki

Go to the newly created folder "myNewWiki" and run:

wirikiki

Zero-install mode

You can just open the html file to get a degraded experience, data will not be saved.

Keyboard shortcuts

Advanced usage

Basic git support is provided, to enable it just type git init in the myKB folder.

cd myKB
git init

Dependencies

• Python 3
  • if you want to run it without the virtualenv you will need the following python packages:
    • aiofiles
    • fastapi
    • uvicorn
• nodejs and npm (BUILD ONLY)
• inotify-tools (DEV ONLY)

Developers note

This is built using Vue.js version 3 for the front and FastAPI for the server side.