VSCode如何配置Markdownlint规则_VSCode统一团队文档格式【规范】

千枫大大_8214

千枫大大_8214

2026-06-14

327人浏览

原创

必须安装davidanson.vscode-markdownlint插件,卸载所有含cli/command字样的干扰插件;配置文件需置于工作区根目录且为合法json;自动修复需开启autofixonsave并禁用prettier冲突。

vscode如何配置markdownlint规则_vscode统一团队文档格式【规范】

怎么确认装的是对的插件

VSCode 里搜 markdownlint,出来一堆名字相近的扩展,但真正提供编辑器内实时标红、悬停提示、保存修复能力的,只有 DavidAnson.vscode-markdownlint。其他像 markdownlint-cli2 或 markdownlint-command 是命令行封装工具,不参与编辑器内校验。

打开 Extensions 面板(Ctrl+Shift+X),搜 markdownlint,只保留发布者是 David Anson 的那个,卸载所有带 cli、command、vscode-markdownlint-prettier 字样的插件——它们会干扰规则加载和修复行为。

装完重启 VSCode,打开一个 .md 文件,手动写一行 ## 标题 (末尾多一个空格),如果立刻出现绿色波浪线并提示 MD024/no-duplicate-heading 类错误,说明插件已生效。

.markdownlint.json 放哪儿才管用

VSCode 的 vscode-markdownlint 插件只认当前工作区根目录下的 .markdownlint.json(或 .markdownlint.yaml),不会向上递归查找父文件夹,也不会读取用户全局设置里的 markdownlint.config —— 只要项目根目录存在本地配置文件,它就直接忽略你 settings.json 里写的任何 markdownlint.config。

确保你用的是 File > Open Folder 打开整个项目文件夹,而不是单个 .md 文件;然后把 .markdownlint.json 放在这个打开的文件夹最顶层。

Markdown to PDF (Styled)
Markdown to PDF (Styled)

使用pandoc和wkhtmltopdf将Markdown文件转换为带样式的PDF,支持内置或自定义CSS样式。

下载
  • 配置必须是合法 JSON:双引号、无末尾逗号、不能有注释(// 或 /* */ 都非法)
  • 规则 ID 大小写敏感:MD013 有效,md013 或 MD13 会被静默忽略
  • 想临时跳过某条规则?在文件顶部加 <!-- markdownlint-disable MD013 -->,比改配置更快更安全

哪些规则能自动修复,哪些不能

不是所有规则都支持保存时自动修正。MD013/line-length、MD007/ul-indent、MD029/ol-prefix 这些目前官方标记为不可修复(fixable: false),开了 autoFixOnSave 也白搭。

能修的规则,比如 MD003/headings(标题风格)、MD004/ul-style(列表符号)、MD026/no-trailing-punctuation(结尾标点),必须配合正确配置才能触发:

  • "markdownlint.autoFixOnSave": true(必须显式开启)
  • "editor.formatOnSave": true(格式化流程需启用)
  • 当前文件语言模式是 markdown(右下角状态栏点一下确认,别是 plaintext)
  • 禁用 Prettier 的 formatOnSave,否则它会在 markdownlint 修复后立刻重写,造成“修了又变回去”

验证方式:删掉 prettier 插件,保存一次,看修复是否稳定生效。

团队共用规则时最容易漏掉的细节

团队文档规范落地最难的不是写规则,而是让所有人用同一套配置且不被覆盖。常见断点:

  • 有人在自己用户 settings.json 里写了 markdownlint.config,但项目根目录有 .markdownlint.json,结果他本地生效、别人不生效
  • 规则里用了自定义正则(如 "MD999": { "names": ["/^TODO:/"] }),这类规则一律不可修复,且容易因语法错误导致整个配置加载失败
  • 误把 prettier-plugin-markdown 当成 markdownlint 替代品——它是格式化器,不提供 lint 提示,也不能关规则、调参数

建议团队统一提交 .markdownlint.json 到仓库根目录,并在 README 里注明「此配置不可绕过」,避免个人设置覆盖协作基准。

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1275

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2672

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1909

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1727

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2587

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1818

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1242

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1116

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

454

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程