https://github.com/RoamJS/workbench
https://github.com/RoamJS/workbench
roam roamresearch
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/RoamJS/workbench
- Owner: RoamJS
- License: unlicense
- Created: 2020-06-30T14:45:08.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-04T22:22:37.000Z (over 1 year ago)
- Last Synced: 2024-10-22T19:18:19.932Z (about 1 year ago)
- Topics: roam, roamresearch
- Language: TypeScript
- Homepage: https://roamjs.com/extensions/workbench
- Size: 49.2 MB
- Stars: 286
- Watchers: 7
- Forks: 35
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - roam42
README
# WorkBench
The ultimate swiss army knife of the Roam power user.
WorkBench makes it easy and fast to navigate and manipulate Roam.
## Features
Click on the name of the feature for more details and information about it.
| Plugin | Description |
| ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| [Alert](https://github.com/RoamJs/workbench/blob/main/docs/alert.md) | Allows users to schedule alerts within their graphs. |
| [Attribute Select](https://github.com/RoamJs/workbench/blob/main/docs/attribute-select.md) | Add a dropdown to specific Attributes that shows user set values. |
| [Command Palette+](https://github.com/RoamJs/workbench/blob/main/docs/command-palette-plus.md) | Adds an extensive set of user generated and prebuilt commands to help users push Roam to new places. |
| [Daily Note Popup](https://github.com/RoamJs/workbench/blob/main/docs/daily-note-popup.md) | Toggle your Daily Notes page in a popup window for quick access. |
| [Decorated Blocks](https://github.com/RoamJs/workbench/blob/main/docs/decorated-blocks.md) | Decorates blocks with various configurable features for quick actions. |
| [Deep Nav](https://github.com/RoamJs/workbench/blob/main/docs/deep-nav.md) | Advanced keyboard navigation of Roam using the keyboard, used to jump to any block in a page or sidebar. |
| [Dictionary](https://github.com/RoamJs/workbench/blob/main/docs/dictionary.md) | Rich dictionary at your fingertips right inside of Roam without having to leave Roam. |
| [Format Converter](https://github.com/RoamJs/workbench/blob/main/docs/format-converter.md) | Outputs the current page to various formats. |
| [Hot Keys](https://github.com/RoamJs/workbench/blob/main/docs/hot-keys.md) | Keyboard shortcuts for interacting with the Roam user interface. |
| [Image OCR](https://github.com/RoamJs/workbench/blob/main/docs/image-ocr.md) | Extract the text from an image and add it as child blocks! |
| [Import Article](https://github.com/RoamJs/workbench/blob/main/docs/import-article.md) | Add commands to import web articles directly into Roam. |
| [Live Preview](https://github.com/RoamJs/workbench/blob/main/docs/live-preview.md) | See live and editable previews of page links underneath your mouse cursor. |
| [Mind Map](https://github.com/RoamJs/workbench/blob/main/docs/mindmap.md) | Visualize pieces of your Roam graph as a mind map! |
| [Privacy Mode](https://github.com/RoamJs/workbench/blob/main/docs/privacy-mode.md) | This feature redacts confidential information when showing your Roam database to others. |
| [Table](https://github.com/RoamJs/workbench/blob/main/docs/table.md) | Editable table component that can be used in your Roam database. |
| [Tag Cycle](https://github.com/RoamJs/workbench/blob/main/docs/tag-cycle.md) | Define custom tag cycles tied to a keyboard shortcut! |
| [Tally](https://github.com/RoamJs/workbench/blob/main/docs/tally.md) | Introduces a tally button component to use directly in your Roam graph. |
| [Tutorials](https://github.com/RoamJs/workbench/blob/main/docs/tutorials.md) | Learn how to use extensions and Roam basics right from within Roam. |
| [Weekly Notes](https://github.com/RoamJs/workbench/blob/main/docs/weekly-notes.md) | Enabling workflows surrounding weekly note pages. |
## Enabling Features
All WorkBench features are **disabled** by default.
To disable or enable a module, simply open your Roam Depot settings for each feature and toggle the switch for the given feature.
## Demo
[](https://www.loom.com/share/0ced5bfcfae04ae38813563b4470dfec)
## Migration Guide
_This extension was first started by [TfTHacker](https://twitter.com/tfthacker) as Roam42 and passed over to RoamJS on 04/20/2021. We are deeply appreciative of all of TftHacker's hard work and generosity._
If you have never used `Roam42` while it was a RoamJS extension, you can safely ignore this. For Roam42 users, use the [migration guide](https://github.com/RoamJs/workbench/blob/main/docs/migration-guide.md) to migrate to the Roam Depot version.