書寫規範
-
MD001 - Heading levels should only increment by one level at a ti- Me
標題級數只能每次擴大一個，也就是說不能隔級建立標題，必須h1-h2-h3…這樣 -
MD002 - First heading should be a top level heading
文件的第一個標題必須是最高階的標題，也就是h1 -
MD003 - Heading style
整篇文件的標題格式要統一 -
MD004 - Unordered list style
整篇文件的無序列表的格式要一致 -
MD005 - Inconsistent indentation for list ite- Ms at the sa- Me level
同一個等級的列表的縮排要一致 -
MD006 - Consider starting bulleted lists at the beginning of the line
一級標題不能夠縮排 -
MD007 - Unordered list indentation
無序列表巢狀的時候預設採取兩個空格的縮排方式 -
MD009 - Trailing spaces
行尾最多可以新增兩個空格，超出之後會有警告，最好每次都是兩個空格因為兩個空格剛好可以用來換行 -
MD010 - Hard tabs
不能使用tab來進行縮排，要使用空格 -
MD011 - Reversed link syntax
內聯形式的連結和建立方式是否錯誤，中括號和圓括號是否使用正確 -
MD012 - - Multiple consecutive blank lines
文件中不能有連續的空行（文件末可以有一個空行），在程式碼塊中這個規則不會生效 -
MD013 - Line length
預設行的最大長度是80，對錶格程式碼塊標題都起效果 -
MD014 - Dollar signs used before co- M- Mands without showing output
在程式碼塊中，終端命令前面不需要有美元符號，如果如果程式碼塊中既有終端命令，也有命令的輸出，則終端命令前可以有美元符號($) -
MD018 - No space after hash on atx style heading
標題格式如果是"atx"的話，#號和文字之間需要一個空格隔開 -
MD019 - - Multiple spaces after hash on atx style heading
標題格式如果是"atx"的話，#號和文字之間只需要一個空格隔開，不需要多個 -
MD020 - No space inside hashes on closed atx style heading
在closed_atx格式的標題中，文字和前後的#號之間都需要一個空格隔開 -
MD021 - - Multiple spaces inside hashes on closed atx style heading
在closed_atx格式的標題中，文字和前後的#號之間只需要一個空格隔開，不能有多餘的 -
MD022 - Headings should be surrounded by blank lines
標題的上下行必須都是空格 -
MD023 - Headings - Must start at the beginning of the line
標題行不能縮排 -
MD024 - - Multiple headings with the sa- Me content
在文件中不能有重複性的標題 -
MD025 - - Multiple top level headings in the sa- Me docu- Ment
同一個文件中，只能有一個最高階的標題，預設也只能有一個一級標題 -
MD026 - Trailing punctuation in heading
標題的末尾不能有". , ; : ! ? "這些符號 -
MD027 - - Multiple spaces after blockquote sy- Mbol
在建立引用塊的時候，右尖號與文字之間必須有且只有一個空格 -
MD028 - Blank line inside blockquote
兩個引用區塊間不能僅用一個空行隔開或者同一引用區塊中不能有空行，如果一行中沒有內容，則這一行要用>開頭 -
MD029 - Ordered list ite- M prefix
有序列表的字首序號格式必須只用1或者從1開始的加1遞增數字 -
MD030 - Spaces after list - Markers
列表（有序、無序）的字首符號和文字之間用1個空格隔開，在列表巢狀或者同一列表項中有多個段落時，無序列表縮排兩個空格，有序列表縮排3個空格 -
MD031 - Fenced code blocks should be surrounded by blank lines
單獨的程式碼塊前後需要用空行隔開（除非是在文件開頭或末尾），否則有些直譯器不會解釋為程式碼塊 -
MD032 - Lists should be surrounded by blank lines
列表（有序、無序）前後需要用空行隔開，否則有些直譯器不會解釋為列表，列表的縮排必須一致，否則會警告 -
MD033 - Inline HT- ML
文件中不允許使用ht- Ml語句 -
MD034 - Bare URL used
單純的連結地址需要用尖括號 (<>) 包裹，否則有些直譯器不會解釋為連結 -
MD035 - Horizontal rule style
建立水平線時整篇文件要統一，要和文件中第一次建立水平線使用的符號一致 -
MD036 - E- Mphasis used instead of a heading
不能用強調來代替標題 **** -
MD037 - Spaces inside e- Mphasis - Markers
強調的符號和文字之間不能有空格 -
MD038 - Spaces inside code span ele- Ments
當用單反引號建立程式碼段的時候，單反引號和它們之間的程式碼不能有空格，如果要把單反引號嵌入到程式碼段的首尾，建立程式碼段的單反引號和嵌入的單反引號間要有一個空格隔開 -
MD039 - Spaces inside link text
連結名和包圍它的中括號之間不能有空格，但連結名中間可以有空格 -
MD040 - Fenced code blocks should have a language specified
單獨的程式碼塊（此處是指上下用三個反引號包圍的程式碼塊）應該指定程式碼塊的程式語言，這一點有助於直譯器對程式碼進行程式碼高亮 -
MD041 - First line in file should be a top level heading
文件的第一個非空行應該是文件最高階的標題，預設是1級標題 -
MD042 - No e- Mpty links
連結的地址不能為空 -
MD043 - Required heading structure
要求標題遵循一定的結構，預設是沒有規定的結構 -
MD044 - Proper na- Mes should have the correct capitalization
指定一些名稱，會檢查它是否有正確的大寫 -
MD045 - I- Mages should have alternate text (alt text)
圖片連結必須包含描述文字 -
MD046 - Code block style
整篇文件採用一致的程式碼格式 -
MD047 - Files should end with a single newline character
文件末尾需要一個空行結尾 -
MD048 - Code fence style
程式碼塊如果採用分隔符隔開的方式定義，那麼整篇文件要採用一致的分隔符，都用波浪號或都用反引號。 -
MD049 - Emphasis style should be consistent
整篇文件採用一致的傾斜格式 -
MD050 - Strong style should be consistent
整篇文件採用一致的加粗格式 -
MD051 - Link fragments should be valid
文內連結必須要有效，不能指向一個不存在的標題。 -
MD052 - Reference links and images should use a label that is defined
參考連結和影像應使用定義的標籤 -
MD053 - Fenced code blocks should not have - leading or trailing blank lines
帶有分隔符的程式碼塊不應有前導或尾隨空行 -
MD054 - First line of file should be a top - level heading
檔案的第一行應該是頂級標題 -
MD055 - Multiple top level headings in the same file
同一檔案中多個頂級標題 -
MD056 - No empty code blocks
沒有空程式碼塊 -
MD057 - No inline HTML
沒有內聯HTML