8000 GitHub - dit7ya/roamex: Seamless integration between Emacs org-mode notetaking and highlights/annotations on the web
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

dit7ya/roamex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Roamex

Annotate and highlight on the web but store the data in org files, while seamlessly referencing org-roam nodes.

WARNING

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.

Installation

Backend

cd backend
poetry build
cd dist

pip install <the generated .whl file>

roamex serve

Frontend

Get the .xpi file from me and install in Firefox

Usage

  • 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.

Developing

  • 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

About

Seamless integration between Emacs org-mode notetaking and highlights/annotations on the web

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  
0