https://github.com/roam-unofficial/roam-toolkit
Roam force multiplier
https://github.com/roam-unofficial/roam-toolkit
chrome extension firefox roam roamresearch typescript
Last synced: 11 days ago
JSON representation
Roam force multiplier
- Host: GitHub
- URL: https://github.com/roam-unofficial/roam-toolkit
- Owner: roam-unofficial
- License: mit
- Created: 2020-01-29T04:38:50.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-08T23:38:13.000Z (2 months ago)
- Last Synced: 2025-02-09T00:18:44.701Z (2 months ago)
- Topics: chrome, extension, firefox, roam, roamresearch, typescript
- Language: TypeScript
- Homepage:
- Size: 12.5 MB
- Stars: 477
- Watchers: 13
- Forks: 42
- Open Issues: 79
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-starred-test - roam-unofficial/roam-toolkit - Roam force multiplier (TypeScript)
- awesome-github-repos - roam-unofficial/roam-toolkit - Roam force multiplier (TypeScript)
- awesome-list - roam-toolkit - unofficial | 440 | (TypeScript)
- awesome-roam - Roam Toolkit
README
# Roam Toolkit - [Roam](https://roamresearch.com) 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
[](https://youtu.be/llP-3AqFGL8)
[Document in the video](./media/walkthough_0.1.md)
## Installation
It's available in their respective extension stores for both [Chrome](https://chrome.google.com/webstore/detail/roam-toolkit/ebckolanhdjilblnkcgcgifaikppnhba) & [Firefox](https://addons.mozilla.org/en-US/firefox/addon/roam-toolkit/)
## Features
### Date Manipulation
You can create dates using [**natural language**](https://github.com/wanasit/chrono):
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:
[](https://youtu.be/08o8q_bOedw)
### Live Preview of pages
### Vim Style keyboard shortcuts
For more details, see the [full video](https://youtu.be/ZxtT05CjOyo)
### Spatial Graph Sidebar
You can layout sidebar pages in a mind map ([Full Video](https://youtu.be/Yc1T0micgzk)):
Use the keyboard to navigate. Also save and restore layouts with `Ctrl+Shift+s`/`Ctrl+Shift+o`:
[Firefox isn't supported yet](https://github.com/cytoscape/cytoscape.js-cola/issues/51)
### Other Features
1. Block actions: Delete, Duplicate, Copy Block Reference
1. Task estimates
## Contributing
See [CONTRIBUTING.md](./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:
```bash
npm install # Install dependencies
npm run prod # Transpile the code
```
### Load extension into the browser
#### Chrome
1. Go to: [**chrome://extensions**](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**](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.