VS Code extension

The VS Code extension highlights syntax and previews Raindown files with --stdin, rendering as you type. In Markdown files it highlights <{ }> directives and renders them in the built-in Markdown preview.

	Markdown	Raindown
File extensions	.md, .markdown	.rd, .raindown
Highlights <{ :toc }>	✓	✓
Highlights :toc		✓
Preview	The built-in Markdown preview	Raindown: Open Preview (Cmd+Shift+V)

Directives in code and comments aren't highlighted, matching what Raindown renders.

The previews render the unsaved text with raindown FILE --stdin, so they update as you type and never change the file. The table of contents and table alignment are written to the file by raindown FILE, and endpoints only run there with -x.

Install

The extension isn't on the VS Code Marketplace yet. Package it from the source and install it:

git clone https://github.com/raindeer-rb/raindown.git
cd raindown/vscode
npx @vscode/vsce package
code --install-extension raindown-*.vsix

Requirements

The raindown executable, from the standalone binary or via gem install raindown. If raindown isn't on your PATH then set raindown.path to the full path of the executable.

Settings

Setting	Default	Description
raindown.path	raindown	The file path to the raindown executable
raindown.markdownPreview	true	Highlight Raindown syntax in the built-in Markdown preview