A tiny desktop wiki
Project description
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.
In comparison to Jupyter it lacks the python notes but brings:
- speed / light footprint
- simplicity of use
- uncluttered UI supporting both dark & bright modes
- more advanced markdown support via markItDown and plugins and Marked for the editor
- auto archival (using git)
Installation
Building
3 alternative ways to get a runnable code:
- download a release (TODO)
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
Key | Description |
---|---|
Escape | Close editor or modal, else toggles the sidebar |
Del | Delete current page |
E | Edit current note |
F | Search/Find something |
N | Create a new note |
Left/Right | Switch to previous/next note |
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
- if you want to run it without the virtualenv you will need the following python packages:
- 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
wirikiki-1.1.1.tar.gz
(1.3 MB
view hashes)