Package: pervane
Pervane |Demo|Install & Run|Wiki|DiscussPervane is a 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 while it can be used as a cloud IDE too with awesome code highlighting.
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.FeaturesCompletely private, your files, your computer, no database, no installation
(apart from some general python packages). There is no statistic collection through any medium. (I only checkpypi stats)Self hosted (working on a managed version if anyone is interested, drop a messsage!)Notes are stored as plain text files with the names given by yourself. Pervane
doesn't rename automatically.Extremely fast UI with quick note switches.Tabbed UI.No added metadata files etc. Just globs your files, caches for N seconds and
creates the file tree.Source of truth is your own file system so you can use your favorite markdown
editor to modify your notes: QOwnNotes, VSCode, Sublime Text etc.Ignore some files in order not to be shown on the sidebar.Flask based server, totally hackable, just modify, it's all yours.Minimal dependencies, single binary.Usessilver searcher (ag)for
searching in an instant throughout the whole folder.Thanks to ag, no indexing or prework is done for search. You can just start
using Pervane with one line command.File tree with proper infinite number of nesting, works well for hierarchical
note taking and knowledge base building.Cookie based authentication.No stats collection, all private.Rich text editing experience thanks toeditor.md.Spell checkerFind an replace within the editor.Hide/show previewFull screen editing mode with F11 or toolbarHide/show toolbarLots of themes thanks to editor.mdMove files in between directories with drag & drop functionality.Keyboard shortcutsQuick fuzzy file name searchEdit code notes directlyDrag & Drop file upload in anywhere in the pageImage/Video rendering in case you they are in the directory.Directory browser with breadcrumb paths.TeX/KaTeX, emoji, task list support.WYSIWYG editorToggle-able sidebar.Dark mode by default with many themes like monokai, solarized etc.Side-by-side markdown preview with sync scroll.Full screen Zen mode for writing.Autosave.ScreenshotsAll of the screenshots and more video are located inPervane Wiki.Install via pipscreen
pipinstallpervane# First make sure you create the admin userpervane--mode=init# Then run the app for reals.# You can login with your recently created credentials.pervane--dir=example/When you go to localhost:5000, Pervane only accepts 1
user. So your notes will only be visible by this single user.⚠️ If you see a server error, delete your cookies and retry.If you are upgrading from a version before 0.0.9You will probably see errors about user is not existing. You need to runpervane --mode=initfirst.
I've changed user auth mode again (had to, because flask-user is deprecated). Sorry about it.Package details here:https://pypi.org/project/pervane/You can run Pervane also with Docker or build it from source. Please visitPervane Wikifor more installation options.ContributePlease and thank you :)# Init:gitclonehttps://github.com/hakanu/pervane.git&&cdpervane# Set up local env.virtualenv-ppython3envsourceenv/bin/activate
pipinstall-rrequirements.txt# Runpython3pervane/serve.py--debug=true