Markdown Auto Space

Format Chinese-English spacing in Markdown for VS Code.

保存时自动修正 Markdown 中的中英混排空格，支持格式化整篇 / 选区，并用波浪线提示不符合规则的位置。

VS Code Marketplace

Why install it

如果你经常写中文技术文档、README、博客或知识库，Markdown 里最容易反复手改的就是这些细节：

• 中文English -> 中文 English
• 使用`rapidocr`库 -> 使用 `rapidocr` 库
• 网速10Gbps -> 网速 10 Gbps
• 15 %的提升 -> 15% 的提升
• 买了iPhone ，好开心 -> 买了 iPhone，好开心

这个扩展把这些排版修正放进 VS Code 的日常编辑流里，不需要再手动全局替换。

What it does

• 只处理 Markdown 文件，不会误改代码文件
• 支持 手动保存时自动修正
• 支持 Format Document / 选区格式化
• 支持 诊断提示（squiggles），像 markdownlint 一样直接标出问题位置
• 支持 9 条可单独开关的规则（MAS001–MAS009）
• 支持 VS Code Desktop 和 VS Code for the Web（vscode.dev、github.dev）

Rules covered

扩展当前覆盖的规则包括：

规则说明、更多示例与配置方式见 docs/RULES.md。

Safe by default

扩展会保护这些内容，避免格式化时误伤：

• Markdown 链接：[text](https://github.com/SWHL/markdown-auto-space/blob/HEAD/url)
• 图片：![alt](https://github.com/SWHL/markdown-auto-space/raw/HEAD/url)
• 行内代码：反引号包裹内容
• 独立 URL：https://...
• 双引号 / 单引号内容
• HTML 标签
• 围栏代码块、缩进代码块、YAML front matter

也就是说，它针对的是 Markdown 文案排版，不是代码美化器。

Install

在 VS Code 扩展市场搜索以下任一关键词即可找到：

• Markdown Auto Space
• markdown chinese spacing
• markdown cjk spacing
• markdown formatter chinese

或直接安装：

code --install-extension SWHL.markdown-auto-space

Usage

1. Save to fix

默认开启 markdownAutoSpace.formatOnSave，你手动保存 Markdown 文件时会自动修正空格问题。

2. Format document or selection

• 命令面板运行 Markdown Auto Space: Format Markdown Spacing / 对当前文档执行中英文加空格
• 命令面板运行 Markdown Auto Space: Format Selection / 仅格式化选中行/选区
• 也可以从编辑器标题栏或右键菜单触发

3. See diagnostics before fixing

开启 markdownAutoSpace.diagnostics.enable 后，扩展会像 markdownlint 一样用波浪线提示问题，并显示对应规则码：

• MAS001: 中英文 / 数字之间应有空格
• MAS002: 中文与行内代码之间应有空格
• MAS003: 中文与链接 / URL 之间应有空格
• MAS004: 英文 / 数字间的顿号应改为逗号加空格
• MAS005: 斜杠与中文之间应有空格
• MAS006: 超链接 [] 内中英文混排时英文左右应有空格
• MAS007: 数字与单位之间应有空格
• MAS008: 度数、百分号与数字之间不应有空格
• MAS009: 全形标点旁不应有空格

Configuration

例如关闭部分规则：

{
  "markdownAutoSpace.rules": {
    "MAS005": false,
    "MAS009": false
  }
}

Behavior details

• 仅在语言 ID 为 markdown 的文件中生效
• 自动保存、失焦保存不会触发 formatOnSave
• 未选中内容时，“格式化选中”会处理当前光标所在行
• 无需修改时不会产生空编辑，避免文档脏状态抖动

Rule docs

更完整的规则说明、输入输出示例和与《中文文案排版指北》的对应关系见 docs/RULES.md。

Changelog

完整历史见 CHANGELOG.md。

Development

pnpm lint
pnpm typecheck
pnpm test
pnpm package:vsix

References

• 中文文案排版指北
• markdownlint
• autocorrect
• vscode-auto-space

License

MIT © SWHL