MarkdownRule

MD001 標題等級應該每次只增加1,如#後應該是##,而不是###

MD002 第一個標題應該是top level,即#

MD003 統一標題風格如使用了#string 則不應該再使用#string#

MD018-021 標題文字和#符應該被一個空格分隔

MD022 標題和正文應該被一個空行分隔

MD023 標題不應該被縮進

MD024 連續的不同標題不應該有同樣的內容

MD025 一個md文件只應有一個top level的標題

MD026 標題後不應有標點符號

MD036 在標題中不要使用強調符’*‘或者’_’

MD041 md文件第一行應該是top level的標題

列表 MD004 統一列表風格如使用*,則不應該在同級使用+或者-

MD005 同級的列表應該置於同樣的縮進下

MD006 列表的初級不應該有縮進

MD007 列表的每級縮進是2個空格(可以被修改)

MD029 順序列表允許兩種格式

第一種是順序序列,如

第二種只有一個數

MD030 列表標記符後一般跟一個空格

MD032 列表與文本之間用空行分隔

塊 MD027 塊引用後應該只有一個空格

MD028 塊引用中的空行也需要加上>頭符號

MD031 代碼塊與文本之間用空行分隔

MD033 避免在Markdown文件中使用原生的HTML

符號 MD009 任何行的末尾不應該有多餘的空格

MD010 任何行不應該含有Hard tab 符號. 用空格替代tab符號

MD011 使用鏈接時,應該使用如下格式名稱,不應反轉他們的順序

MD034 使用URL時,使用尖括號包圍URL

MD042 鏈接()內不可留空,填充以#

MD035 使用分隔線時,統一風格,使用’-‘或者’*',不要混用

分隔線應該是連續的,中間不要有空格

MD012 換行時不應有超過1行的空行

MD013 每行不應該超過80個字符(一個中文字符佔兩個字符)

MD014 在代碼塊中展示shell腳本時,如果只需要展示命令,則不應該在命令頭加入$符號.當需要區分命令和輸出時再使用$符號

MD037 使用強調符的時候,強調符中不應有空格

MD038 使用string代碼塊時,`符旁不應該有空格

MD039 使用鏈接時,[]和()旁不應該有空格

MD040 使用```代碼塊時,需要指定代碼的語言

MD046 統一代碼塊的縮進

MD045 圖像文件應該有解釋文本

MD047 md文件的結尾應該有多餘的一個空行