vscode 编写 markdown文档时规则提醒插件 markdownlint

首先安装插件 markdownlint

插件会在编写文档时格式不正确时，提示错误信息，便于及时改正

常见的错误信息

错误码	错误原因
MD001	标题级数只能每次扩大一个，也就是说不能隔级创建标题，必须h1-h2-h3
MD002	文档的第一个标题必须是最高级的标题，也就是h1
MD003	整篇文档的标题格式要统一
MD004	整篇文档的无序列表的格式要一致
MD005	同一个等级的列表的缩进要一致
MD006	一级标题不能够缩进
MD007	无序列表嵌套的时候采取两个空格的缩进方式
MD008	暂无
MD009	行尾最多可以添加两个空格，超出之后会有警告，最好每次都是两个空格因为两个空格刚好可以用来换行
MD010	不能使用tab来进行缩进，要使用空格
MD011	内联形式的链接和创建方式是否错误，中括号和圆括号是否使用正确
MD012	文档中不能有连续的空行（文档末可以有一个空行），在代码块中这个规则不会生效
MD013	默认行的最大长度是80，对表格代码块标题都起效果
MD014	在代码块中，终端命令前面不需要有美元符号，如果如果代码块中既有终端命令，也有命令的输出，则终端命令前可以有美元符号($)
MD015	暂无
MD016	暂无
MD017	暂无
MD018	标题格式如果是"atx"的话，#号和文字之间需要一个空格隔开
MD019	标题格式如果是"atx"的话，#号和文字之间只需要一个空格隔开，不需要多个
MD020	在closed_atx格式的标题中，文字和前后的#号之间都需要一个空格隔开
MD021	在closed_atx格式的标题中，文字和前后的#号之间只需要一个空格隔开，不能有多余的
MD022	标题的上下行必须都是空格
MD023	标题行不能缩进
MD024	在文档中不能有重复性的标题
MD025	同一个文档中，只能有一个最高级的标题，默认也只能有一个一级标题
MD026	标题的末尾不能有". , ; : ! ? "这些符号
MD027	在创建引用块的时候，右尖号与文字之间必须有且只有一个空格
MD028	两个引用区块间不能仅用一个空行隔开或者同一引用区块中不能有空行，如果一行中没有内容，则这一行要用>开头
MD029	有序列表的前缀序号格式必须只用1或者从1开始的加1递增数字
MD030	列表（有序、无序）的前缀符号和文字之间用1个空格隔开，在列表嵌套或者同一列表项中有多个段落时，无序列表缩进两个空格，有序列表缩进3个空格
MD031	单独的代码块前后需要用空行隔开（除非是在文档开头或末尾），否则有些解释器不会解释为代码块
MD032	列表（有序、无序）前后需要用空行隔开，否则有些解释器不会解释为列表，列表的缩进必须一致，否则会警告
MD033	文档中不允许使用html语句
MD034	单纯的链接地址需要用尖括号 (<>) 包裹，否则有些解释器不会解释为链接
MD035	创建水平线时整篇文档要统一，要和文档中第一次创建水平线使用的符号一致
MD036	不能用强调来代替标题
MD037	强调的符号和文字之间不能有空格
MD038	当用单反引号创建代码段的时候，单反引号和它们之间的代码不能有空格，如果要把单反引号嵌入到代码段的首尾，创建代码段的单反引号和嵌入的单反引号间要有一个空格隔开
MD039	不能用强调来代替标题
MD040	单独的代码块（此处是指上下用三个反引号包围的代码块）应该指定代码块的编程语言
MD041	文档的第一个非空行应该是文档最高级的标题，默认是1级标题
MD042	链接的地址不能为空

参考文章