A Roam Research extension that provides Vim-like keyboard navigation for blocks. Ported from roam-toolkit.
- Block Navigation: Navigate between blocks using
j/kkeys - Panel Navigation: Switch between main panel and sidebar panels with
h/l - Search: Search within visible blocks with
/ - Hint System: Quick access to links within blocks using hint keys
- Mode Indicator: Visual indicator showing current mode
| Key | Description |
|---|---|
j |
Move down |
k |
Move up |
h |
Switch to left panel |
l |
Switch to right panel |
gg |
Jump to first block |
G |
Jump to last block |
| Key | Description |
|---|---|
i |
Enter insert mode (start) |
a |
Enter insert mode (end) |
o |
Insert block below |
O |
Insert block above |
V |
Enter visual mode (line) |
dd |
Delete block |
u |
Undo |
Ctrl+R |
Redo |
z |
Toggle fold |
c |
Center current block |
| Key | Description |
|---|---|
/ |
Search in visible blocks |
n |
Go to next match |
N |
Go to previous match |
When a block is selected, clickable elements (links, references, checkboxes) show hint labels:
| Key | Description |
|---|---|
q, w, e, r, t, b |
Click hint 0-5 |
Shift+ hint key |
Shift-click hint (open in sidebar) |
| Key | Description |
|---|---|
Escape |
Return to normal mode |
? |
Toggle help panel |
Note: This is an experimental feature with an empty default configuration. Enable it in Settings > Vim Mode > "Enable Spacemacs-style Leader Key".
Press Space in Normal mode to open the which-key popup. The framework is preserved for future use or user customization.
- Open Roam Research
- Go to Settings > Roam Depot
- Search for "Vim Mode"
- Click Install
- Clone this repository
- Run
npm install && npm run build - Open Roam Research
- Go to Settings > Roam Depot
- Enable Developer Mode
- Click "Load unpacked extension"
- Select the folder containing
extension.js
# Install dependencies
npm install
# Build
npm run build
# Watch mode (auto-rebuild on changes)
npm run watchTo reload the extension after making changes:
- Disable and re-enable the extension in Roam Depot, or
- Refresh Roam Research
This extension is a port of the vim-mode feature from roam-toolkit, adapted to work as a standalone Roam Depot extension.
MIT