Skip to content

VS Code Extension ​

The wiremd VS Code extension gives a live preview of any .md wireframe as you type — no terminal required.

Install from the Marketplace ​

  1. Open the Extensions panel in VS Code (Cmd+Shift+X on Mac, Ctrl+Shift+X on Windows/Linux)
  2. Search wiremd preview, or open the marketplace page directly
  3. Click Install

That's it. No Node.js or terminal setup needed.

Open the preview ​

Open any .md file, then open the preview using any of these:

  • Click the wiremd item in the VS Code status bar (bottom of the window)
  • Press Cmd+K V (Mac) or Ctrl+K V (Windows/Linux)
  • Open the Command Palette (Cmd+Shift+P) → wiremd: Open Preview to the Side
  • Click the preview icon in the editor toolbar (top-right when editing a markdown file)

The preview panel opens alongside your editor and updates live as you type.

Change the visual style ​

Use the style dropdown in the preview toolbar to switch between:

StyleLook
sketchBalsamiq-inspired hand-drawn (default)
cleanModern minimal
wireframeTraditional grayscale
materialGoogle Material Design
tailwindUtility-first with purple accents
brutalNeo-brutalism, bold colors
noneUnstyled HTML

You can also set a default in your VS Code settings:

json
// .vscode/settings.json
{
  "wiremd.defaultStyle": "clean"
}

Preview at different screen sizes ​

Click the Viewport button in the preview toolbar to pick a size: Desktop, Laptop, Tablet, Mobile, or Full Width.

Browse the component reference ​

Click the ? button in the preview toolbar to open the component docs — a rendered, interactive reference of every wiremd component, served directly from the extension.

Claude skill (optional) ​

On first launch, the extension offers to install the wiremd Claude skill:

"Want Claude Code to generate wireframes for you? Install the Claude skill."

Click Install Skill to copy the skill into .claude/skills/wireframe/ in your workspace. This lets Claude Code understand wiremd syntax and generate wireframes from descriptions or specs. Click Not Now to skip — you can always install it later via the Command Palette: wiremd: Install Claude Skill.

If you don't use Claude Code, skip this.


Build from source ​

If you want to modify the extension or use an unreleased build:

bash
cd vscode-extension
npm install
npm run compile

Press F5 in VS Code to launch an Extension Development Host with the local build loaded.

See vscode-extension/DEVELOPMENT.md for the full contributor workflow, including how to rebuild after changes to the wiremd library.