Annotate and highlight on the web but store the data in org files, while seamlessly referencing org-roam nodes.
This is in a horribly WIP state, not at all ready for daily usage. Expect bugs, breaking changes, and low-quality code all around. You are still welcome to try it and provide feedback if you are super excited about the idea of finally being able to integrating org-modes and the browser.
cd backend
poetry build
cd dist
pip install <the generated .whl file>
roamex serve
Get the .xpi file from me and install in Firefox
- Create a config file at ~~/.config/roamex/config.yaml~ which has the following three fields.
org_roam_directory : "<PATH TO YOUR ORG ROAM DIRECTORY>" org_roam_db_location : "<PATH TO YOUR ORG ROAM DB>" roamex_db_location : "<PATH WHERE YOU WANT YOUR ROAMEX DB TO BE>"
- Create a directory called
roamex
under your org roam directory. - Open a webpage, select some text, follow the buttons.
- clone repo locally
- follow first two steps of usage
- run the backend server
cd backend
poetry run uvicorn src.api:app --reload
- start the fronend build script
cd frontend
node buildscript.js
- start a firefox with the extension installed via web-ext
cd frontend/dist
web-ext run -v