Sätteri Markdown Preview
A VS Code extension that renders a live Markdown preview using
Sätteri (a Rust Markdown/MDX engine) instead of
the built-in markdown-it renderer.
Status: early development.
Usage
Open a Markdown file and you have a few options:
- Click the Extension's Logo button in the top-right menu bar to open the preview.
- Press Ctrl/Cmd+Shift+V to open the preview in the current editor group.
- Press Ctrl/Cmd+P and type
Sätteri: Open Preview to open the preview in the current editor group.
Commands & keybindings
| Command |
Keybinding |
| Sätteri: Open Preview |
Ctrl/Cmd+Shift+V |
| Sätteri: Open Preview to the Side |
Ctrl/Cmd+K V |
| Sätteri: Refresh Preview |
- |
These keybindings match VS Code's built-in Markdown preview, so with both
installed the two collide. To make Sätteri win, unbind the built-in ones in your
keybindings.json:
{ "key": "ctrl+shift+v", "command": "-markdown.showPreview", "when": "editorLangId == markdown" },
{ "key": "ctrl+k v", "command": "-markdown.showPreviewToSide", "when": "editorLangId == markdown" }
Settings
| Setting |
Default |
Description |
satteriMarkdownPreview.gfm |
true |
GFM (tables, strikethrough, task lists, autolinks, footnotes). |
satteriMarkdownPreview.math |
false |
Parse $…$ / $$…$$ math (no bundled KaTeX/MathML stylesheet in v1). |
satteriMarkdownPreview.showFrontmatter |
true |
Show the frontmatter block at the top of the preview. |
satteriMarkdownPreview.customCss |
"" |
Path to an extra stylesheet, loaded after the built-in styles. |
Development
Package manager is Bun.
bun install
bun run build
Then press F5 in VS Code to launch the Extension Development Host.
Open a .md file and run Sätteri: Open Preview from the command palette or click the preview command in the top-right menu bar.
Testing
Unit tests run in Bun (native bun:test); the vscode and satteri
modules are mocked (see test/setup.ts), so they cover the pure logic - HAST
plugins, the HTML shell/CSP, config, debounce - without a host or the native
engine.
bun test test/unit # or: bun run test
bun run test:watch
Integration tests run the real extension in a throwaway VS Code build via
@vscode/test-electron. This is where the native Sätteri binary and the
vscode API are actually exercised (extension activates, commands register, a
preview opens). Run from Windows Terminal:
bun run test:integration
Sätteri has its own MDAST/HAST plugin model (defineMdastPlugin /
defineHastPlugin). Existing remark/rehype plugins do not work here; features
are implemented against Sätteri's plugin API or as HTML post-processing.
