The knowledge IDE
A web-based text editor for networked note-taking, self-hostable on any Git repository.
Want a host-free alternative? Check out the sister project: Tundra.
Install dependencies
Then run in terminal
npx @osmoscraft/osmosnote@latest
Get Docker for your operating system
docker run -p 6683:6683 osmoscraft/osmosnote
You can open the app in your browser, at http://localhost:6683. To exit, press Ctrl + Space, then press q.
docker ps # Find your container_id in the output
docker kill container_id # Manually stop the container
When running from the container, you won't be able to persist any content after the container exits. Follow the Storage setup guide to persist your notes.
This project is still in its early stage. Expect breaking changes and feature overhauls. Some ideas on top of my head:
CodeMirror
and Monaco
. I will continue assess this trade-off and adopt open-source editor library as needed. Currently, a vim-like keybinding is supported with caveats. See notes for vim users.My top priority is to modularize the system so I can tackle customization and theming without building technical debt. Until then, I have limited bandwidth for new features. Ideas and bug reports are welcome. I'll get to them as soon as I free up. Thank you for being patient with this project.
This project is inspired by all of the great text editors and note taking apps out there. You should check them out and see if they are better solutions for you specific needs:
Browse other projects from the OsmosCraft ecosystem.