Pervane Plain text file based note taking and knowledge base building tool

Pervane is a bare minimum plain text file based note taking and knowledge base building tool. It doubles as simple file server to render given directories files in web browser. It’s like python’s built-in SimpleHTTPServer but a little bit feature richer like WYSIWYG note taking experience, sidebar with infinite number of nesting, blazing fast text search, file moving, creating from the browser etc.

Download as .zip Download as .tar.gz View on GitHub

Pervane | Demo

Pervane is a bare minimum plain text file based note taking and knowledge base building tool. It doubles as simple file server to render given directories files in web browser. It’s like python’s built-in SimpleHTTPServer but a little bit feature richer like WYSIWYG note taking experience, sidebar with infinite number of nesting, blazing fast text search, file moving, creating from the browser etc.

Main use case is to create, edit, serve and search the markdown notes in combination with example source files.

If you are using plain text based note taking, this can be helpful for adhoc mediums like operating systems which don’t have large desktop app ecosystem like ChromeOS or mobile OS like Android and iOS.

Personally tried many alternatives as file server like allmark, mdserv, markdown-server but none of them seem like providing all features I’m looking for. I just want to be able to see the folder hierarchy and fuzzy text search and some better-than-basic markdown rendering.

For the other note taking and knowledge base building apps, there is always something missing although how advanced they go.

What I need:

Comparison

Inspired from this one from notable author.

Please shoot an email if I miss anything.

Discuss

Features

Keyboard shortcuts

Sync - backup

Since it’s normal file system files, you can use any sync mechanism to sync your files with one of these

Mobile

I’m working on a lightweight mobile app to list and modify the notes. For now you can use an mobile editor app with a syncing app as a workaround. I use syncthing for this.

Testimonials

I have moved all my keep notes, blog posts and project wiki notes from trello and notion.so to pervane. They total around 324 directories, 1579 files tree -a .

But it’s not

Demo

Video

Pervane note taking app demo

Screenshots

Generel view of the app

Table preview in markdown editor

tex and katex preview in the markdown editor

Flowcharts preview

Sequence diagram in the editor

Settings

Create new directory

Edit recently created file

Folder hierarchy in file browser

Editing this file from this app

Install

Via pip

screen
pip install pervane
pervane --dir=example/

When you go to localhost:5000, you need to register. Pervane only accepts 1 user. So your notes will only be visible by this single user.

Package details here: https://pypi.org/project/pervane/

Without pip

# Run it in screen to make it always run.
screen

# Download the latest version.
git clone https://github.com/hakanu/pervane.git
cd pervane/pervane
python3 serve.py --dir=example/

Update

The tool is still under heavy development, I update the package in pypi multiple times per week. Would be great if you keep updating with:

pip install --upgrade pervane

Options

Contribute

# Init:
git clone https://github.com/hakanu/pervane.git

# Set up local env.
virtualenv -p python3 env
source env/bin/activate
pip install flask markdown2 Flask-Caching Flask-HTTPAuth

# Run
python3 serve.py --debug=true

Stack

Tried to keep the code as simple as possible since I need to take notes today.

TODO

Keep the engine running

https://www.buymeacoffee.com/haku