mdsmith

项目概述

mdsmith 是一个用 Go 编写的 Markdown 检查器和格式化工具。它检查风格、可读性、结构和跨文件完整性，并自动修复可修复的问题。

主要功能

• 自动修复：mdsmith fix 自动修复空格、标题、代码围栏、列表缩进和表格对齐
• 跨文件完整性：检查整个文档树的交叉引用和一致性
• 可读性限制：文件大小、章节大小、阅读难度等级和句子数限制
• LSP 支持：提供 mdsmith lsp 服务器，支持 VS Code 扩展和 Claude Code 插件
• markdownlint 兼容：可通过 mdsmith init --from-markdownlint 迁移配置

适用人群

• 需要保持 Markdown 文档一致性的文档作者
• 使用 CI 检查文档质量的团队
• 希望编辑器内实时诊断的用户

快速上手

1. 从 Releases 页面 下载静态 Go 二进制
2. 检查文档：mdsmith check
3. 自动修复：mdsmith fix
4. 从 markdownlint 迁移：mdsmith init --from-markdownlint

核心优势

• 比 Node markdownlint 快一个数量级
• 跨文件完整性检查，不只是单文件风格检查
• 统一的规则引擎在 CI、编辑器和 AI 代理中保持一致

系统要求

• 操作系统：跨平台
• 支持架构：amd64、arm64