怎么在VSCode中使用Markdown Lint_VSCode Markdown规范检查与修复

大丽酱_2505

大丽酱_2505

2026-05-28

894人浏览

原创

vscode中markdownlint不生效,需确认安装davidanson.vscode-markdownlint插件、配置文件置于工作区根目录且为合法json、启用"markdownlint.autofixonsave":true并禁用prettier冲突。

怎么在vscode中使用markdown lint_vscode markdown规范检查与修复

VSCode 里装了 markdownlint 却没反应?不是插件坏了,而是它默认不修、不标红、不提示——得手动开关键开关,且容易被其他插件(比如 Prettier)静默覆盖。

怎么确认装的是真·Markdown Lint 插件

VSCode 扩展市场搜 “markdownlint”,结果里名字相似的很多:markdownlint-cli2、markdownlint-command、markdownlint-server 都只是命令行封装或后台服务,**不提供编辑器内实时波浪线和悬停提示**。

真正起作用的只有:DavidAnson.vscode-markdownlint(发布者是 David Anson,ID 完全匹配)。其他一概卸载,否则会干扰规则加载或语言模式识别。

  • 打开 Extensions 面板(Ctrl+Shift+X),搜 markdownlint,只留一个 ID 是 DavidAnson.vscode-markdownlint 的
  • 重启 VSCode,打开任意 .md 文件,输入 ## 标题 (末尾多一个空格),看是否立刻标黄提示 MD024 或 MD009
  • 右下角状态栏点一下语言模式,确认是 markdown,不是 plaintext 或 markdown (plain)

为什么改了 .markdownlint.json 还不生效

vscode-markdownlint 只读你用 File > Open Folder 打开的那个文件夹根目录下的 .markdownlint.json(或 .markdownlint.yaml),**不会向上递归找父目录,也不会读用户 settings.json 里的 markdownlint.config 字段**。

常见失效原因:

  • .markdownlint.json 放在子目录(如 docs/.markdownlint.json),但工作区根是项目顶层,插件根本看不到
  • JSON 写错:用了单引号、末尾多逗号、加了 // 注释(JSON 不支持注释)
  • 规则 ID 大小写写错,比如 "md013": false → 实际必须是 "MD013": false
  • 配置里写了不可修复规则(如 MD007、MD029),却误以为能自动修

怎么让保存时自动修复可修项

默认状态下,vscode-markdownlint **只报错、不修复**。要让它动手,得同时满足三个条件:

Markdown Canvas
Markdown Canvas

将Markdown文件转换为美观的HTML页面,适用于Canvas或浏览器查看。用于用户请求渲染、可视化、显示或分享Markdown文件时。

下载
  • 在 settings.json 中启用:"markdownlint.autoFixOnSave": true
  • 确保 "editor.formatOnSave": true(否则 save 触发不了修复流程)
  • 禁用 Prettier 的自动格式化冲突:"[markdown]": { "editor.formatOnSave": false },或改用 editor.codeActionsOnSave 精确控制

更稳妥的写法(推荐):

{
  "markdownlint.autoFixOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.markdownlint": true
  },
  "[markdown]": {
    "editor.formatOnSave": false
  }
}

这样修复走 code action 流程,不跟 Prettier 的 format 流程打架。验证方式:保存后看波浪线是否消失,而不是内容反复“跳动”。

哪些规则能修、哪些不能修,怎么看

不是所有规则都支持自动修复。markdownlint 官方文档中每条规则页会标注 fixable: true 或 fixable: false。例如:

  • MD004(无序列表符号统一)→ 可修
  • MD013(行长度)→ 默认不可修(除非你用 CLI + --fix,VSCode 插件不支持)
  • MD026(标题末尾标点)→ 可修
  • 自定义正则规则(MD999 类)→ 一律不可修,仅提示

临时禁用某条规则最灵活的方式不是改配置,而是在文件顶部加注释:<!-- markdownlint-disable MD013 -->。注意:HTML 注释语法必须完整,且需独占一行。

真正麻烦的从来不是配不配得上,而是多个插件对同一文件反复操作——Prettier 加空格、markdownlint 删空格、再保存又加回来。这种循环,只靠开开关关解决不了,得明确谁负责 format、谁负责 fix、谁彻底让路。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode markdown

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.06.30

1255

18

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

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

2023.07.21

2632

3

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

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

2024.03.14

1889

12

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

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

2024.03.14

1707

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

1798

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

热门下载

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

精品课程

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