Skip to content

Latest commit

 

History

History
103 lines (61 loc) · 3.34 KB

README.md

File metadata and controls

103 lines (61 loc) · 3.34 KB
Raw

Roam Toolkit - Roam force multiplier

Browser extension designed to improve your experience of using Roam Research

The development is supported by - a service that allows you to publish your Roam notes as a beautiful static website (digital garden)

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:

Replace mode:

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

Implements SM2 Spaced repetition algorithm (Anki version) as described here: https://docs.ankiweb.net/#/faqs?id=what-spaced-repetition-algorithm-does-anki-use for Roam blocks.
Put a cursor inside the block and pres Ctrl+Shift+ [number between 1 and 4 signifying ease of remembering this card], and the plugin is going to reschedule the Block accordingly (tagging it with the appropriate date, and some metadata tags)

Watch the video for more details: Watch the video for details on how to use it

Live Preview of pages

Vim Style keyboard shortcuts

For more details, see the full video

Spatial Graph Sidebar

You can layout sidebar pages in a mind map (Full Video):

Use the keyboard to navigate. Also save and restore layouts with Ctrl+Shift+s/Ctrl+Shift+o:

Firefox isn't supported yet

Other Features

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

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.