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
| 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.
Metadata
Release files for wirikiki 1.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| wirikiki-1.1.2.tar.gz | 1.4 MB | Without provenance | Details for wirikiki-1.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| wirikiki-1.1.2-py3-none-any.whl | Python 3 | none | any | Details for wirikiki-1.1.2-py3-none-any.whl |
Total release size: 2.8 MB
Release files / wirikiki-1.1.2.tar.gz
| Download URL | wirikiki-1.1.2.tar.gz |
|---|---|
| Size | 1.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dda03d7ab2dc5be15abc5efb65a5c46f74e52a673563d936e16f2ad84cc3d3ff
|
|
BLAKE2b-256 checksum How to use checksums |
6ac5ccba7e6b2520d75dc94fa779f0e3647b3f03c9ed7408caf2ae8b8d3d6fcb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.14 CPython/3.10.6 Linux/5.19.2-zen1-1-zen
|
Release files / wirikiki-1.1.2-py3-none-any.whl
| Download URL | wirikiki-1.1.2-py3-none-any.whl |
|---|---|
| Size | 1.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1f145e4687b34ed4392a07b44b1bec1b5396079ccf438123f1395a80a22013ab
|
|
BLAKE2b-256 checksum How to use checksums |
c20cca2aabc3ebf5bc314dc1762ae6d036b56615f85bd3573f8e49f4c1fc938a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.14 CPython/3.10.6 Linux/5.19.2-zen1-1-zen
|
Security for wirikiki 1.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.