/roam-toolkit

Roam force multiplier

Primary LanguageTypeScriptMIT LicenseMIT

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, Copy Block Reference
  4. Task estimates
  5. Custom CSS
  6. Live Preview of pages

Contributing

See CONTRIBUTING.md for details on how to start contributing.

Running the development version

  1. Checkout the repository

  2. In terminal or command prompt run the following commands:

    npm install # Install dependencies
npm run prod # Transpile the code

Load extension into the browser

Chrome

  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. That's it.

Firefox

  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. That's it.