/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

Features

Date Manipulation

You can create dates using natural language:

You can also increment or decrement dates:

  • While editing a block, press Ctrl-Alt-Up/Down to increment/decrement any date inside. If a block has multiple dates, place your cursor on the date.

Spaced Repetition

  • Anki SRS algorithm & Shortcuts
  • Leitner System automation shortcuts

Live Preview of pages

Vim Style keyboard shortcuts

For more details, see the full video

Other Features

  1. Block actions: Delete, Duplicate, Copy Block Reference
  2. Task estimates
  3. Custom CSS

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.