mdsmith

Project Overview

mdsmith is a Markdown linter and formatter written in Go. It checks style, readability, structure, and cross-file integrity, and auto-fixes what can be fixed cleanly.

Key Features

• Auto-fix: mdsmith fix rewrites whitespace, headings, code fences, list indentation, and table alignment
• Cross-file integrity: Checks cross-references and consistency across the entire docs tree
• Readability limits: File size, section size, reading grade, and sentence count limits
• LSP support: mdsmith lsp server with VS Code extension and Claude Code plugin
• markdownlint compatible: Migrate config with mdsmith init --from-markdownlint

Target Audience

• Documentation authors who need consistent Markdown
• Teams using CI to check documentation quality
• Users who want real-time diagnostics in their editor

Quick Start

1. Download the static Go binary from the Releases page
2. Check documents: mdsmith check
3. Auto-fix: mdsmith fix
4. Migrate from markdownlint: mdsmith init --from-markdownlint

Core Advantages

• An order of magnitude faster than Node markdownlint
• Cross-file integrity checks beyond single-file style linting
• One rule engine runs consistently in CI, editor, and AI agents

System Requirements

• OS: Cross-platform
• Architectures: amd64, arm64