Markdown 语法规范：摘要

本文总结了 markdownlint 列出的 Markdown 语法规范。

标题

标签：headings

• MD001 - 标题层级应逐级递增，最多六级。
• MD003 - 标题样式应一致。
• MD018 - ATX 标题前缀 # 后需接一个空格。
• MD019 - ATX 标题前缀 # 后仅需一个空格。
• MD020 - 封闭 ATX 标题首尾 # 与标题内容之间需接一个空格。
• MD021 - 封闭 ATX 标题首尾 # 与标题内容之间仅需一个空格。
• MD022 - 应使用空行分隔标题与正文。
• MD023 - 标题不应缩进。
• MD024 - 标题内容不应重复。
• MD025 - 同一文档内只应存在一个最高层级标题。
• MD026 - 标题不应以标点符号结尾。
• MD036 - 不应使用强调代替标题。
• MD041 - 文档首行应为最高层级标题。
• MD043 - 可自定义结构化标题。

强调

标签：emphasis

• MD036 - 不应使用强调代替标题。
• MD037 - 强调符号 * / _ 与强调文本之间不应有空格。
• MD049 - 斜体样式应一致。
• MD050 - 粗体样式应一致。

拼写

标签：spelling

• MD044 - 专有名词应规范大小写。

空格

标签：whitespace

• MD009 - 除引入换行外，行末不应有空格。
• MD010 - 应使用空格代替制表符。

空行

标签：blank_lines

• MD012 - 不应使用连续空行。
• MD022 - 应使用空行分隔标题与正文。
• MD031 - 应使用空行分隔代码块与正文。
• MD032 - 应使用空行分隔列表与正文。
• MD047 - 文档应以空行结束。

行宽

标签：line_length

• MD013 - 单行文本不应过长。

引用

标签：blockquote

• MD027 - 引用前缀 > 后只需一个空格。
• MD028 - 引用多行内容使，应在分段空行前加引用前缀 >；应在不同引用之间穿插正文。

列表

标签：ol、ul

• MD004 - 无序列表项的前缀符号应一致。
• MD005 - 相同层级列表项的缩进应一致。
• MD007 - 嵌套无序列表项的缩进应一致。
• MD029 - 有序列表项的前缀序号应遵循一定顺序。
• MD030 - 列表项前缀符号与内容之间的空格数应一致。
• MD032 - 应使用空行分隔列表与正文。

分割线

标签：hr

• MD035 - 水平分割线样式应一致。

代码

标签：code

• MD014 - 一般无需在终端指令前加 $ 符号，除非需同时显示该指令的输出结果。
• MD031 - 应使用空行分隔代码块与正文。
• MD038 - 行内代码符号 ` 与代码之间不应有空格。
• MD040 - 应标注代码块使用的编程语言。
• MD046 - 代码块样式应一致。
• MD048 - 代码块围栏样式应一致。

链接

标签：links、images

• MD011 - 应正确使用链接语法。
• MD034 - 应将裸 URL 或邮箱地址置于一对尖括号 <> 中。
• MD039 - 链接符号 [ / ] 与链接文本之间不应有空格。
• MD042 - 链接地址不应为空。
• MD045 - 图片应包含描述。
• MD051 - 页内标题跳转地址应有效。
• MD052 - 参考式链接或图片的标记应有效。
• MD053 - 链接或图片地址的定义不应闲置。

HTML

标签：html

• MD033 - 不使用 HTML 语法。

---

• markdownlint：Markdown 语法检查和清洗工具。