Skip to content

classicrob/roam-toolkit

 
 

Repository files navigation

Roam Toolkit - Roam force multiplier

Browser extension designed to improve your experience of using Roam Research

WalkThrough

Watch the video

Document in the video

Installation

It's available in their respective extension stores for both Chrome & Firefox

Currently supported functionality

  1. Fuzzy Date functionality

  1. Date increment/decrement
    • If there is only 1 date in the block - place the cursor anywhere withing it and press Ctrl-Alt-Up/Down, if there is more then 1 date - you need to place the cursor within the name of the date.
  2. Spaced repetition
    • Anki SRS algorithm & Shortcuts
    • Leitner System automation shortcuts
  3. Block actions: Delete, Duplicate
  4. Task estimates
  5. Custom CSS

Running the development version

  1. Checkout the repository
  2. Revert the https://github.com/roam-unofficial/roam-toolkit/commit/20ad9560b7cfaf71adf65dbc3645b3554c2ab598 change locally to allow Toolkit to properly run in the development mode

In terminal or command prompt

install dependencies
 - npm install
Transpile the code
 - npm run dev (only transpiles the code)
 - npm run watch (transpiles and watches for code changes)


yarn commands will work too if yarn is installed.

In Chrome web browser

  1. Go to: chrome://extensions
  2. Toggle: "developer mode" on.
  3. Click on: "Load unpacked"
  4. Select the newly created folder "dist" from the project folder.
  5. Thats it.

In Firefox web browser

  1. Go to: about:debugging
  2. Select: "Enable add-on debugging"
  3. Click on: "Load Temporary Add-on…"
  4. Open the newly created folder "dist" from the project folder, and choose the "manifest.json" file.
  5. Thats it.

License

MIT

About

Roam force multiplier

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 85.8%
  • JavaScript 13.7%
  • HTML 0.5%