Marksmith

The smart Markdown toolkit for VS Code / Windsurf.

Smart Paste · Bi-directional Preview · Document X-Ray — and everything you need for Markdown.

한국어 | 中文 | 日本語

Highlights

Smart Paste

Automatically converts clipboard content into optimal Markdown.

• HTML → Markdown — Converts HTML copied from web pages/Word into clean Markdown
• URL → Link — Auto-fetches page title when pasting a URL to create [title](https://github.com/rakkunn/MarkSmith/blob/HEAD/url)
• Table Data → Table — Converts TSV/CSV copied from Excel/Google Sheets into Markdown tables
• Selected Text + URL — Automatically wraps selected text as a link when pasting a URL

Bi-directional Preview

The preview and editor are synchronized bidirectionally.

• Click → Source Jump — Click a preview element to jump to the corresponding line in the editor
• Scroll Sync — Real-time synchronization between editor scroll and preview scroll
• Checkbox Toggle — Click checkboxes in the preview to automatically update the source
• Inline Edit — Double-click text in the preview to edit directly
• Incremental Update — Patches only changed DOM elements instead of full re-render

Document X-Ray

Real-time document analysis in the sidebar.

• Word Count / Reading Time — Supports mixed CJK/Latin documents, always shown in status bar
• Average LLM Tokens — Heuristic token estimation across GPT, Claude, and Gemini
• Readability Score — 0–100 score based on sentence length, heading structure, and word complexity
• Heading Structure Tree — Click to jump to the corresponding position
• Word Frequency Chart — Identify overused words at a glance
• Link Health Check — Validates all URLs in the document

Enhanced Preview

• Live Preview — Renders in a Webview panel simultaneously with editing
• KaTeX Math — Renders $...$ (inline) and $$...$$ (block) math expressions
• Mermaid Diagrams — Automatically renders ```mermaid code blocks
• 3 Themes — GitHub, Dark, and Minimal themes
• Task Lists — Checkbox support

Linter / Formatter

• markdownlint Integration — Auto-lints on save, results shown in Problems panel
• Auto Formatter — Normalizes blank lines, removes trailing whitespace, unifies bullets

Agent AI Workflow (Zero-Friction)

Designed for the era where AI generates Markdown documents for you.

• Copy Optimized for AI — A 1-click CodeLens at the top of your document compresses tables, removes blanks, and copies minified markdown to save LLM tokens.
• Hallucination Quick Fix — Automatically underlines AI placeholders ([TODO]) and broken local links. Click the 💡 icon to remove or fix them instantly, or run Fix All.
• Context Map (Orphan Scanner) — In the X-Ray sidebar, instantly see which local files link to the current document. Alerts you if an AI-generated document is "Orphaned" (not linked anywhere).

Export (Pro-level Typography)

• HTML Export — Saves as a complete HTML file with theme applied
• PDF Export — High-quality PDF generation via Chromium with advanced Print CSS best practices
  • Smart Page Breaks — Gracefully splits code blocks across pages while cloning borders and backgrounds (box-decoration-break: clone)
  • Table Headers — Repeats table headers across pages when split
  • Orphan/Widow Control — Prevents single lines of text from being stranded at page edges

Security (Secure by Design)

• XSS Protection — Strict HTML sanitization via DOMPurify ensures malicious scripts never execute in the preview
• RCE Prevention — PDF exports run in a fully sandboxed Puppeteer environment, preventing system-level exploits
• SSRF Blocked — Smart Paste intelligently blocks internal IP tracking and infinite redirect loops

Settings

Commands

Support

If you find Marksmith useful, please consider sponsoring the project.

License

MIT