Skip to content

README.md

Latest commit

 

History

History
61 lines (46 loc) · 2.63 KB

README.md

File metadata and controls

61 lines (46 loc) · 2.63 KB
Raw

mdsmith for VS Code

Inline mdsmith diagnostics and quick fixes for Markdown.

The extension spawns mdsmith lsp over stdio. It surfaces lint diagnostics as inline squiggles. Each fixable rule contributes a quick fix. A source.fixAll.mdsmith action runs mdsmith fix on the whole buffer.

Prerequisites

  • VS Code 1.85 or later.
  • The mdsmith binary — the extension bundles a cross-platform binary from npm that works on Linux, macOS, and Windows from a single extension install. No separate binary install is required in most cases. If the bundled binary fails to install (corporate proxies, offline environments), you can install mdsmith manually:
    • npm install -g @mdsmith/cli
    • go install github.com/jeduden/mdsmith/cmd/mdsmith@latest
    • Download from the releases page
    • Then configure mdsmith.path to point to the binary.

Install

code --install-extension mdsmith-<version>.vsix

Settings

Setting Default Purpose
mdsmith.path "mdsmith" Binary path; defaults to bundled cross-platform binary. Falls back to PATH resolution. Set absolute path if needed (e.g. /go/bin/mdsmith)
mdsmith.config "" Override -c config path
mdsmith.run "onSave" When to lint: onType, onSave, or off
mdsmith.fixOnSave false Wires source.fixAll.mdsmith on save
mdsmith.trace.server "off" LSP trace verbosity

See the full guide for prerequisites, code actions, troubleshooting, and the performance benchmark.

Building from source

The extension uses Bun for both bundling and tests:

bun install
bun test
bun run build.ts            # one-shot bundle to dist/
bun run build.ts --watch    # rebuild on change

bunx --bun @vscode/vsce package produces the .vsix.

License

MIT.