Vimium Markdown Preview adds Vimium-style keyboard navigation to VS Code's built-in Markdown preview. Its key-sequence design takes inspiration from Vimium's KeyHandlerMode. This extension implements the interactions for Markdown previews without copying Vimium source code or using its Chrome extension runtime. Thanks to Phil Crosby and all Vimium contributors.
Features
Scroll, search preview text, and open links from the keyboard.
Run only in the built-in Markdown preview. Navigation is enabled by default and does not intercept editor input.
Hold a scroll key to move at a fixed linear rate. Scrolling stops when you release the key.
Keep text fields, editable regions, modifier-key combinations, and IME composition input unaffected.
Keyboard shortcuts
h / j / k / l or arrow keys: scroll left, down, up, or right.
d / u: scroll down or up by half a page.
gg / G: scroll to the top or bottom.
1 to 99 followed by a scroll key: repeat the motion. For example, 3j scrolls down three times.
i: enter insert mode. Press Esc to return to navigation.
\: toggle navigation off or on.
?: show keyboard help. Press Esc to close it.
/: search preview text. Matches appear while you type. Press Enter to confirm or Esc to cancel. Use n or N to move to the next or previous match.
f: show link hints. Type a hint code to open its link, or press Esc to cancel.
Vimium attribution
This extension uses Vimium's KeyHandlerMode as a reference for key-sequence behavior. It implements that behavior independently for the Markdown preview. Vimium is maintained by Phil Crosby and contributors under the MIT License.
Development checks
pnpm test: build the extension and run the unit tests for state transitions.
pnpm test:e2e: verify interactions in a controlled local HTML page.
pnpm test:preview: verify script injection and trusted keyboard input in an isolated VS Code Extension Development Host.
pnpm test:vsix: package the extension, install the VSIX in isolated storage, and verify preview wiring.
