Rules
这篇文章是对Markdown lint的规则部分的简要翻译
原文地址
标题
标题等级应该每次只增加1,如#后应该是##,而不是###
第一个标题应该是top level,即#
统一标题风格 如使用了#string 则不应该再使用#string#
标题文字和#符应该被一个空格分隔
标题和正文应该被一个空行分隔
标题不应该被缩进
连续的不同标题不应该有同样的内容
一个md文件只应有一个top level的标题
标题后不应有标点符号
在标题中不要使用强调符'*'或者'_'
md文件第一行应该是top level的标题
列表
统一列表风格 如使用*,则不应该在同级使用+或者-
同级的列表应该置于同样的缩进下
列表的初级不应该有缩进
列表的每级缩进是2个空格(可以被修改)
顺序列表允许两种格式
第一种是顺序序列,如
1.
2.
3.
第二种只有一个数
1.
1.
1.
列表标记符后一般跟一个空格
列表与文本之间用空行分隔
块
块引用后应该只有一个空格
块引用中的空行也需要加上>头符号
代码块与文本之间用空行分隔
避免在Markdown文件中使用原生的HTML
符号
任何行的末尾不应该有多余的空格
任何行不应该含有 Hard tab 符号. 用空格替代tab符号
使用链接时,应该使用如下格式 [名称](链接),不应反转他们的顺序
换行时不应有超过1行的空行
每行不应该超过80个字符(一个中文字符占两个字符)
在代码块中展示shell脚本时,如果只需要展示命令,则不应该在命令头加入(符号.当需要区分命令和输出时再使用)符号
使用URL时,使用尖括号包围URL
使用分隔线时,统一风格,使用'-'或者'*',不要混用
分隔线应该是连续的,中间不要有空格
使用强调符的时候,强调符中不应有空格
使用`string`代码块时,`符旁不应该有空格
使用链接时,[]和()旁不应该有空格
使用```代码块时,需要指定代码的语言
链接()内不可留空,填充以#
图像文件应该有解释文本
统一代码块的缩进
md文件的结尾应该有多余的一个空行
使用链接时,[]和()旁不应该有空格
使用```代码块时,需要指定代码的语言
链接()内不可留空,填充以#
图像文件应该有解释文本
统一代码块的缩进
md文件的结尾应该有多余的一个空行