markdownlint 規(guī)則介紹

規(guī)則

本文檔包含所有規(guī)則的描述,它們要檢查的內(nèi)容以及違反規(guī)則的文檔示例和示例的更正版本。標(biāo)題為擊中 已棄用,但仍提供向后兼容性。

MD001-標(biāo)題級(jí)別一次只能增加一個(gè)級(jí)別

標(biāo)簽:標(biāo)題,標(biāo)題

別名:標(biāo)題增加,標(biāo)題增加

當(dāng)您跳過markdown文檔中的標(biāo)題級(jí)別時(shí),將觸發(fā)此規(guī)則,例如:

# 標(biāo)題1

### 標(biāo)題3

我們跳過了本文檔中的第二級(jí)標(biāo)題

使用多個(gè)標(biāo)題級(jí)別時(shí),嵌套標(biāo)題一次只能增加一個(gè)級(jí)別:

# 標(biāo)題1

## 標(biāo)題2

### 標(biāo)題3

#### 標(biāo)題4

## 另一個(gè)標(biāo)題2

### 另一個(gè)標(biāo)題3

原理:標(biāo)題表示文檔的結(jié)構(gòu),并且在跳過時(shí)可能會(huì)造成混淆-特別是對(duì)于可訪問性方案。更多信息:https : //www.w3.org/WAI/tutorials/page-structure/headings/。

MD002-第一個(gè)標(biāo)題應(yīng)該是頂層標(biāo)題

標(biāo)簽:標(biāo)題,標(biāo)題

別名:first-heading-h1,first-header-h1

參數(shù):級(jí)別(數(shù)字;默認(rèn)值1)

注意:MD002已被棄用,默認(rèn)情況下處于禁用狀態(tài)。 MD041 /第一行標(biāo)題提供了改進(jìn)的實(shí)現(xiàn)。

此規(guī)則旨在確保文檔標(biāo)題從頂層開始,并在文檔的第一個(gè)標(biāo)題不是h1標(biāo)題時(shí)觸發(fā):

## 這不是H1標(biāo)題

### 另一個(gè)標(biāo)題

文檔中的第一個(gè)標(biāo)題應(yīng)為h1標(biāo)題:

# 從H1標(biāo)題開始

## 然后將H2用于小節(jié)

注意:level在外部添加h1的情況下,該參數(shù)可用于更改頂層(例如:更改為h2)。

理由:頂級(jí)標(biāo)題通常充當(dāng)文檔的標(biāo)題。更多信息:https : //cirosantilli.com/markdown-style-guide#top-level-header。

MD003-標(biāo)題樣式

標(biāo)簽:標(biāo)題,標(biāo)題

別名:標(biāo)題樣式,標(biāo)題樣式

參數(shù):樣式(“ consistent”,“ atx”,“ atx_closed”,“ setext”,“ setext_with_atx”,“ setext_with_atx_closed”;默認(rèn)為“ consistent”)

在同一文檔中使用不同的標(biāo)題樣式(atx,setext和“ closed” atx)時(shí),將觸發(fā)此規(guī)則:

#  ATX風(fēng)格H1

## 封閉的ATX樣式H2 ##

Setext樣式H1
===============

與文檔中使用的標(biāo)題樣式保持一致:

#  ATX風(fēng)格H1

##  ATX風(fēng)格H2

setext_with_atx和setext_with_atx_closed文檔樣式允許具有setext樣式標(biāo)題的文檔中級(jí)別為3或更高的atx樣式標(biāo)題:

Setext樣式H1
===============

Setext樣式H2
---------------

###  ATX風(fēng)格H3

注意:配置的標(biāo)題樣式可以是要使用的特定樣式(atx,atx_closed,setext,setext_with_atx,setext_with_atx_closed),或者只是要求用法在文檔中保持一致。

基本原理:一致的格式設(shè)置使文檔理解更加容易。

MD004-無序列表樣式

標(biāo)簽:子彈,ul

別名:ul-style

參數(shù):樣式(“一致”,“星號(hào)”,“加號(hào)”,“破折號(hào)”,“子列表”;默認(rèn)為“一致”)

當(dāng)文檔中用于無序列表項(xiàng)的符號(hào)與配置的無序列表樣式不匹配時(shí),將觸發(fā)此規(guī)則:

*項(xiàng)目1
 +項(xiàng)目2
 -項(xiàng)目3

要解決此問題,請(qǐng)為整個(gè)文檔中的列表項(xiàng)使用配置的樣式:

*項(xiàng)目1
 *項(xiàng)目2
 *項(xiàng)目3

配置的列表樣式可以是要使用的特定符號(hào)(星號(hào),加號(hào),破折號(hào)),可以要求文檔中的用法必須一致,或者可以要求每個(gè)子列表具有與其父列表不同的一致符號(hào)。

例如,以下內(nèi)容對(duì)于sublist樣式有效,因?yàn)樽钔饷娴目s進(jìn)使用星號(hào),中間的縮進(jìn)使用加號(hào),而最里面的縮進(jìn)使用破折號(hào):

*項(xiàng)目1
   +項(xiàng)目2
     -項(xiàng)目3
   +項(xiàng)目4
 *項(xiàng)目4
   + 5項(xiàng)

基本原理:一致的格式設(shè)置使文檔理解更加容易。

MD005-同一級(jí)別的列表項(xiàng)縮進(jìn)不一致

標(biāo)簽:項(xiàng)目符號(hào),ul,縮進(jìn)

別名:列表縮進(jìn)

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)列表項(xiàng)被解析為相同級(jí)別但沒有相同的縮進(jìn)時(shí),將觸發(fā)此規(guī)則:

*項(xiàng)目1
   *嵌套項(xiàng)目1
   *嵌套項(xiàng)目2
    *未對(duì)齊的項(xiàng)目

通常,此規(guī)則會(huì)因輸入錯(cuò)誤而觸發(fā)。更正列表的縮進(jìn)以解決該問題:

*項(xiàng)目1
   *嵌套項(xiàng)目1
   *嵌套項(xiàng)目2
   *嵌套項(xiàng)目3

順序排列的列表標(biāo)記通常左對(duì)齊,以使所有項(xiàng)目都具有相同的起始列:

...
 8.項(xiàng)目
 9.項(xiàng)目
 10.項(xiàng)目
 11.項(xiàng)目
...

此規(guī)則還支持列表標(biāo)記的右對(duì)齊,以使所有項(xiàng)目都具有相同的結(jié)束列:

...
  8.項(xiàng)目
  9.項(xiàng)目
 10.項(xiàng)目
 11.項(xiàng)目
...

理由:違反此規(guī)則可能會(huì)導(dǎo)致內(nèi)容渲染不正確。

MD006-考慮在行的開頭開始項(xiàng)目符號(hào)列表

標(biāo)簽:項(xiàng)目符號(hào),ul,縮進(jìn)

別名:ul-start-left

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)頂級(jí)列表不在行首時(shí)觸發(fā)此規(guī)則:

一些文字

  *清單項(xiàng)目
   *清單項(xiàng)目

要解決此問題,請(qǐng)確保不縮進(jìn)頂層列表項(xiàng):

一些測(cè)試

*清單項(xiàng)目
 *清單項(xiàng)目

注意:在以下情況下會(huì)觸發(fā)此規(guī)則,因?yàn)榻馕銎鳠o法識(shí)別無序子列表。沒有按照外部有序列表的要求嵌套3個(gè)字符,而是創(chuàng)建了一個(gè)頂級(jí)無序列表。

1.清單項(xiàng)目
   -清單項(xiàng)目
   -清單項(xiàng)目
 1.清單項(xiàng)目

原理:從行首開始列出列表意味著,當(dāng)使用編輯器的縮進(jìn)功能或Tab鍵進(jìn)行縮進(jìn)時(shí),嵌套列表項(xiàng)都可以縮進(jìn)相同的數(shù)量。在列表中以1個(gè)空格開頭表示第一個(gè)嵌套列表的縮進(jìn)小于第二個(gè)級(jí)別的縮進(jìn)(如果使用4個(gè)空格鍵,則為3個(gè)字符;如果使用2個(gè)空格鍵,則為1個(gè)字符)。

MD007-無序列表縮進(jìn)

標(biāo)簽:項(xiàng)目符號(hào),ul,縮進(jìn)

別名:ul-indent

參數(shù):indent,start_indented(數(shù)字;默認(rèn)為2,布爾值;默認(rèn)為false)

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

如果列表項(xiàng)未縮進(jìn)配置的空格數(shù)(默認(rèn)值:2),則會(huì)觸發(fā)此規(guī)則。

例:

*列表項(xiàng)
    *嵌套列表項(xiàng)縮進(jìn)3個(gè)空格

更正的示例:

*列表項(xiàng)
   *嵌套列表項(xiàng)縮進(jìn)2個(gè)空格

注意:僅當(dāng)子列表的父列表也都是無序的時(shí),此規(guī)則才適用于子列表(否則,有序列表的額外縮進(jìn)會(huì)干擾該規(guī)則)。

start_indented參數(shù)允許列表的第一級(jí)縮進(jìn)配置的空格數(shù),而不是從零開始(MD006的倒數(shù))。

原理:縮進(jìn)2個(gè)空格可以使嵌套列表的內(nèi)容與父列表內(nèi)容的開頭在列表標(biāo)記后使用單個(gè)空格時(shí)保持一致。縮進(jìn)4個(gè)空格與代碼塊一致,并且使編輯者更容易實(shí)現(xiàn)。此外,這對(duì)于需要4位縮進(jìn)的多重markdown解析器可能是一個(gè)兼容性問題。更多信息:https : //cirosantilli.com/markdown-style-guide#indentation-of-content-inside-listshttp://support.markedapp.com/discussions/problems/21-sub-lists-not-indenting。

MD009-尾隨空格

標(biāo)簽:空白

別名:無尾跡空間

參數(shù):br_spaces,list_item_empty_lines,嚴(yán)格(數(shù)字;默認(rèn)值為2,布爾值;默認(rèn)為false,布爾值;默認(rèn)值為false)

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

在以意外空格結(jié)尾的任何行上都會(huì)觸發(fā)此規(guī)則。要解決此問題,請(qǐng)從行尾刪除尾隨空格。

br_spaces參數(shù)允許例外的尾隨空格的具體數(shù)目,通常用來插入一個(gè)明確的換行符。默認(rèn)值允許2個(gè)空格指示硬中斷(
元素)。

注意:必須br_spaces將此參數(shù)設(shè)置為> = 2才能生效。設(shè)置br_spaces為1的行為與0相同,不允許任何尾隨空格。

默認(rèn)情況下,即使使用了允許的空格數(shù),該規(guī)則也不會(huì)觸發(fā),即使它不會(huì)造成硬中斷(例如,在段落的結(jié)尾)。要同時(shí)報(bào)告此類實(shí)例,請(qǐng)將strict參數(shù)設(shè)置為true

文字文字文字
文字[2個(gè)空格]

通常不需要使用空格來縮進(jìn)列表項(xiàng)內(nèi)的空白行,但是某些解析器需要這樣做。將list_item_empty_lines參數(shù)設(shè)置true 為允許此操作(即使stricttrue):

-清單項(xiàng)目文字
  [2個(gè)空格]
  清單項(xiàng)目文字

基本原理:除非用于創(chuàng)建換行符,否則尾隨空格沒有任何用途,并且不會(huì)影響內(nèi)容的呈現(xiàn)。

MD010-硬標(biāo)簽

標(biāo)簽:空格,hard_tab

別名:無困難

參數(shù):code_blocks(布爾值;默認(rèn)為true)

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

該規(guī)則由包含硬制表符而不是使用空格縮進(jìn)的任何行觸發(fā)。要解決此問題,請(qǐng)用空格替換所有硬標(biāo)簽字符。

例:

一些文字

    *用于縮進(jìn)列表項(xiàng)的硬制表符

更正的示例:

一些文字

    *用于縮進(jìn)列表項(xiàng)的空格

您可以選擇針對(duì)代碼塊排除此規(guī)則。為此,請(qǐng)將code_blocks參數(shù)設(shè)置 為false。默認(rèn)情況下包括代碼塊,因?yàn)楣ぞ邔?duì)制表符的處理通常是不一致的(例如:使用4個(gè)空格對(duì)8個(gè)空格)。

原理:硬標(biāo)簽通常由不同的編輯器不一致地顯示,并且比空格更難使用。

MD011-反向鏈接語法

標(biāo)簽:鏈接

別名:無反向鏈接

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)遇到看似鏈接的文本,但語法似乎已經(jīng)顛倒([]()顛倒了)時(shí),將觸發(fā)此規(guī)則:

(錯(cuò)誤的鏈接語法)[https://www.example.com/]

要解決此問題,請(qǐng)交換[]()

[ 正確的鏈接語法 ](https://www.example.com/)

注意:Markdown Extra樣式的腳注不會(huì)觸發(fā)此規(guī)則:

對(duì)于(例如)[^ 1]

理由:反向鏈接不呈現(xiàn)為可用鏈接。

MD012-多個(gè)連續(xù)的空白行

標(biāo)簽:空格,blank_lines

別名:無多個(gè)空白

參數(shù):最大值(數(shù)字;默認(rèn)值1)

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)文檔中有多個(gè)連續(xù)的空白行時(shí),將觸發(fā)此規(guī)則:

一些文字在這里

一些更多的文字在這里

要解決此問題,請(qǐng)刪除有問題的行:

一些文字在這里

一些更多的文字在這里

注意:如果代碼塊中有多個(gè)連續(xù)的空白行,則不會(huì)觸發(fā)此規(guī)則。

注意:該maximum參數(shù)可用于配置連續(xù)空白行的最大數(shù)量。

基本原理:除代碼塊外,空行沒有任何作用,也不影響內(nèi)容的呈現(xiàn)。

MD013-線長(zhǎng)

標(biāo)簽:line_length

別名:行長(zhǎng)

參數(shù):line_length,heading_line_length,code_block_line_length,code_blocks,表,標(biāo)題,標(biāo)頭,strict,stern(數(shù)字; * _ length,布爾值默認(rèn)為80;默認(rèn)為true(strict / stern除外,默認(rèn)為false))

如果headings未提供,headers將使用(不推薦使用)。

當(dāng)行數(shù)超過配置的行line_length(默認(rèn)值:80個(gè)字符)時(shí),將觸發(fā)此規(guī)則。要解決此問題,請(qǐng)將行分成多行。要為標(biāo)題設(shè)置不同的最大長(zhǎng)度,請(qǐng)使用 heading_line_length。要為代碼塊設(shè)置不同的最大長(zhǎng)度,請(qǐng)使用 code_block_line_length

當(dāng)沒有超出配置的行長(zhǎng)的空白時(shí),此規(guī)則將是一個(gè)例外。這樣一來,您仍然可以包含長(zhǎng)網(wǎng)址之類的項(xiàng)目,而不會(huì)被迫在中間將其破壞。要禁用此異常,請(qǐng)將strict參數(shù)設(shè)置為 true在任何行太長(zhǎng)時(shí)報(bào)告問題。要警告行太長(zhǎng)且可以修復(fù)但允許行不帶空格的行,請(qǐng)將stern參數(shù)設(shè)置為true。

例如(假設(shè)正常行為):

如果這條線是最大長(zhǎng)度
這行是可以的,因?yàn)槌鲈撻L(zhǎng)度沒有空格
這行是違反的,因?yàn)橛?這行也可以,因?yàn)槟抢餂]有空格

strictstern模式下,上面的兩條中間線是沖突。第三行是strict模式中的違規(guī),但在stern模式中是允許的。

您可以選擇針對(duì)代碼塊,表或標(biāo)題排除此規(guī)則。要做到這一點(diǎn),設(shè)置code_blocks,tablesheadings參數(shù)(S)為false。

默認(rèn)情況下,此規(guī)則中包括代碼塊,因?yàn)樗ǔJ俏臋n可讀性的要求,并且暫時(shí)與代碼規(guī)則兼容。盡管如此,某些語言還是不適合短線。

基本原理:在某些編輯器中,很難排長(zhǎng)行。更多信息:https : //cirosantilli.com/markdown-style-guide#line-wrapping。

MD014-命令前使用美元符號(hào)而不顯示輸出

標(biāo)簽:代碼

別名:commands-show-output

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)有代碼塊顯示要鍵入的shell命令并且所有 shell命令前面都帶有美元符號(hào)($)時(shí),將觸發(fā)此規(guī)則:

$ ls
$ cat foo
$少吧

在這種情況下,美元符號(hào)是不必要的,因此不應(yīng)包括在內(nèi):

ls
貓富
少吧

在帶有美元符號(hào)的命令前顯示輸出不會(huì)觸發(fā)此規(guī)則:

$ ls
富吧
$ cat foo
你好,世界
$貓吧
巴茲

由于某些命令不會(huì)產(chǎn)生輸出,因此如果某些 命令沒有輸出,則不會(huì)違反:

$ mkdir測(cè)試
mkdir:創(chuàng)建目錄“ test”
$ ls測(cè)試

基本原理:如果不需要時(shí)省略美元符號(hào),則復(fù)制/粘貼起來會(huì)更容易,并且噪音也更少。有關(guān) 更多信息,請(qǐng)參見 https://cirosantilli.com/markdown-style-guide#dollar-signs-in-shell-code。

MD018-atx樣式標(biāo)題上的散列后沒有空格

標(biāo)簽:標(biāo)題,標(biāo)題,atx,空格

別名:無遺失空間atx

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)atx樣式標(biāo)題中的井號(hào)字符后缺少空格時(shí),將觸發(fā)此規(guī)則:

#標(biāo)題1

##標(biāo)題2

要解決此問題,請(qǐng)將標(biāo)題文本與井號(hào)字符分開一個(gè)空格:

# 標(biāo)題1

## 標(biāo)題2

理由:違反此規(guī)則可能會(huì)導(dǎo)致內(nèi)容渲染不正確。

MD019-atx樣式標(biāo)題上的散列后有多個(gè)空格

標(biāo)簽:標(biāo)題,標(biāo)題,atx,空格

別名:no-multiple-space-atx

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)在atx樣式標(biāo)題中使用多個(gè)空格將標(biāo)題文本與哈希字符分開時(shí),將觸發(fā)此規(guī)則:

#  標(biāo)題1

##  標(biāo)題2

要解決此問題,請(qǐng)將標(biāo)題文本與井號(hào)字符分開一個(gè)空格:

# 標(biāo)題1

## 標(biāo)題2

理由:多余的空間沒有目的,并且不會(huì)影響內(nèi)容的呈現(xiàn)。

MD020-封閉的atx樣式標(biāo)題上的哈希內(nèi)無空格

標(biāo)簽:標(biāo)題,標(biāo)題,atx_closed,空格

別名:無缺失的封閉式atx

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)封閉的atx樣式標(biāo)題中的哈希字符內(nèi)缺少空格時(shí),將觸發(fā)此規(guī)則:

#標(biāo)題1#

##標(biāo)題2 ##

要解決此問題,請(qǐng)將標(biāo)題文本與井號(hào)字符分開一個(gè)空格:

# 標(biāo)題1#

## 標(biāo)題2 ##

注意:如果標(biāo)題的任一側(cè)缺少空格,則將觸發(fā)此規(guī)則。

理由:違反此規(guī)則可能會(huì)導(dǎo)致內(nèi)容渲染不正確。

MD021-封閉的atx樣式標(biāo)題上的哈希內(nèi)有多個(gè)空格

標(biāo)簽:標(biāo)題,標(biāo)題,atx_closed,空格

別名:no-multiple-spaces-closed-atx

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)在封閉的atx樣式標(biāo)題中使用多個(gè)空格將標(biāo)題文本與哈希字符分開時(shí),將觸發(fā)此規(guī)則:

#  標(biāo)題1#

##  標(biāo)題2 ##

要解決此問題,請(qǐng)將標(biāo)題文本與井號(hào)字符分開一個(gè)空格:

# 標(biāo)題1#

## 標(biāo)題2 ##

注意:如果標(biāo)題的任一側(cè)包含多個(gè)空格,則將觸發(fā)此規(guī)則。

理由:多余的空間沒有目的,并且不會(huì)影響內(nèi)容的呈現(xiàn)。

MD022-標(biāo)題應(yīng)用空白行包圍

標(biāo)簽:標(biāo)題,標(biāo)題,blank_lines

別名:標(biāo)題周圍為空白,標(biāo)題周圍為空白

參數(shù):lines_above,lines_below(數(shù)字;默認(rèn)值為1)

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)標(biāo)題(任何樣式)不位于開頭或后面沒有至少一個(gè)空白行時(shí),將觸發(fā)此規(guī)則:

# 標(biāo)題1
一些文字

一些文字
## 標(biāo)題2

要解決此問題,請(qǐng)確保所有標(biāo)題之前和之后均帶有空白行(除非標(biāo)題位于文檔的開頭或結(jié)尾):

# 標(biāo)題1

一些文字

一些文字

## 標(biāo)題2

lines_abovelines_below參數(shù)可用于指定不同數(shù)量的空白行每個(gè)標(biāo)題的上方或下方(包括0)。

注意:如果將lines_abovelines_below配置為需要多個(gè)空白行,還應(yīng)自定義MD012 /無多個(gè)空白。

基本原理:除了美學(xué)原因外,包括kramdown在內(nèi)的某些解析器也不會(huì)解析以前沒有空行的標(biāo)題,而是將其解析為常規(guī)文本。

MD023-標(biāo)題必須從行首開始

標(biāo)簽:標(biāo)題,標(biāo)題,空格

別名:heading-start-left,header-start-left

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)標(biāo)題縮進(jìn)一個(gè)或多個(gè)空格時(shí),將觸發(fā)此規(guī)則:

一些文字

  #縮進(jìn)標(biāo)題

要解決此問題,請(qǐng)確保所有標(biāo)題均始于該行的開頭:

一些文字

# 標(biāo)題

原理:不在行首的標(biāo)題將不會(huì)被解析為標(biāo)題,而是顯示為常規(guī)文本。

MD024-具有相同內(nèi)容的多個(gè)標(biāo)題

標(biāo)簽:標(biāo)題,標(biāo)題

別名:無重復(fù)標(biāo)題,無重復(fù)標(biāo)題

參數(shù):siblings_only,allow_different_nesting(布爾值;默認(rèn)值false

如果文檔中具有相同文本的多個(gè)標(biāo)題將觸發(fā)此規(guī)則:

# 一些文字

## 一些文字

要解決此問題,請(qǐng)確保每個(gè)標(biāo)題的內(nèi)容都不同:

# 一些文字

## 更多文字

如果將參數(shù)siblings_only(或者allow_different_nesting)設(shè)置為true,則允許對(duì)非同級(jí)標(biāo)題進(jìn)行標(biāo)題重復(fù)(在更改日志中很常見):

# 更改日志

##  1.0.0

### 功能

##  2.0.0

### 功能

理由:某些markdown解析器會(huì)根據(jù)標(biāo)題名稱為標(biāo)題生成錨點(diǎn);具有相同內(nèi)容的標(biāo)題可能會(huì)引起問題。

MD025-同一文檔中的多個(gè)頂級(jí)標(biāo)題

標(biāo)簽:標(biāo)題,標(biāo)題

別名:?jiǎn)螛?biāo)題,單H1

參數(shù):level,front_matter_title(數(shù)字;默認(rèn)值1,字符串;默認(rèn)值“ ^ \ s * title:”)

當(dāng)使用頂層標(biāo)題(文件的第一行是h1標(biāo)題)并且文檔中使用了多個(gè)h1標(biāo)題時(shí),將觸發(fā)此規(guī)則:

# 頂級(jí)標(biāo)題

# 另一個(gè)頂層標(biāo)題

要修復(fù),請(qǐng)對(duì)文檔進(jìn)行結(jié)構(gòu)化,以便有一個(gè)h1標(biāo)題作為該文檔的標(biāo)題,而所有以后的標(biāo)題均為h2或更低級(jí)別的標(biāo)題:

# 標(biāo)題

## 標(biāo)題

## 另一個(gè)標(biāo)題

注意:level在外部添加h1的情況下,該參數(shù)可用于更改頂層(例如:更改為h2)。

如果存在YAML前件并包含一個(gè)title屬性(通常與博客文章一起使用),則此規(guī)則將其視為頂層標(biāo)題,并會(huì)報(bào)告對(duì)任何后續(xù)頂層標(biāo)題的違規(guī)。要在最前面使用其他屬性名稱,請(qǐng)通過front_matter_title參數(shù)指定正則表達(dá)式的文本。要禁用此規(guī)則使用前的事情,指定""front_matter_title。

原理:頂級(jí)標(biāo)題是文件第一行中的h1,并用作文檔的標(biāo)題。如果使用此約定,則文檔的標(biāo)題不能超過一個(gè),并且整個(gè)文檔都應(yīng)包含在此標(biāo)題中。

MD026-標(biāo)題中的標(biāo)點(diǎn)符號(hào)

標(biāo)簽:標(biāo)題,標(biāo)題

別名:無拖尾標(biāo)點(diǎn)

參數(shù):標(biāo)點(diǎn)符號(hào)(字符串;默認(rèn)為“。,;:!?。,;;:?。俊保?/p>

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

在具有指定的標(biāo)準(zhǔn)或全角標(biāo)點(diǎn)字符之一作為行中最后一個(gè)字符的任何標(biāo)題上觸發(fā)此規(guī)則:

# 這是一個(gè)標(biāo)題。

要解決此問題,請(qǐng)刪除結(jié)尾的標(biāo)點(diǎn)符號(hào):

# 這是一個(gè)標(biāo)題

注意:該punctuation參數(shù)可用于指定在標(biāo)題末尾算作標(biāo)??點(diǎn)符號(hào)的字符。例如,您可以將其更改 ".,;:!"為允許以問號(hào)結(jié)尾的標(biāo)題,例如FAQ。將punctuation參數(shù)設(shè)置為""允許所有字符-等同于禁用規(guī)則。

理由:標(biāo)題并非完整的句子。更多信息:https : //cirosantilli.com/markdown-style-guide#punctuation-at-the-end-of-headers

MD027-塊引用符號(hào)后的多個(gè)空格

標(biāo)簽:blockquote,空格,縮進(jìn)

別名:no-multiple-space-blockquote

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)blockquote(>)符號(hào)后有多個(gè)空格時(shí),將觸發(fā)此規(guī)則:

>   這是縮進(jìn)不好的塊式報(bào)價(jià)
>   應(yīng)該只能有一個(gè)。

要解決此問題,請(qǐng)刪除所有多余的空間:

>這是帶有正確
>縮進(jìn)的blockquote 。

基本原理:一致的格式設(shè)置使文檔理解更加容易。

MD028-引用內(nèi)的空白行

標(biāo)簽:blockquote,空格

別名:無空格的引用

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)兩個(gè)blockquote塊之間用空行隔開時(shí),將觸發(fā)此規(guī)則:

>這是一個(gè)引號(hào)
>,后面緊跟著

>此blockquote。不幸的是
>在某些解析器中,這些解析器被視為相同的blockquote。

要解決此問題,請(qǐng)確保彼此相鄰的所有塊引用之間都包含一些文本:

>這是一個(gè)大引用。

吉米也說:

>這也是blockquote。

或者,如果應(yīng)該使用相同的引號(hào),則在空白行的開頭添加blockquote符號(hào):

>這是一個(gè)大引用。
> 
>這是相同的塊引用。

原理:某些markdown解析器會(huì)將兩個(gè)由一個(gè)或多個(gè)空行分隔的塊引用視為同一塊引用,而其他一些則將它們視為單獨(dú)的塊引用。

MD029-有序列表項(xiàng)的前綴

標(biāo)簽:ol

別名:ol-prefix

參數(shù):樣式(“一個(gè)”,“有序”,“一個(gè)或一個(gè)有序”,“零”;默認(rèn)為“一個(gè)或一個(gè)有序”)

對(duì)于不以“ 1”開頭的有序列表,將觸發(fā)此規(guī)則。或沒有以數(shù)字順序增加的前綴(取決于配置的樣式)。使用“ 0”的較少見的模式。也支持作為第一個(gè)前綴或所有前綴。

有效樣式示例(如果樣式配置為“一個(gè)”):

1.這樣做。
1.這樣做。
1.完成。

如果樣式配置為“有序”,則為有效列表的示例:

1.這樣做。
2.這樣做。
3.完成。
0。
1.這樣做。
2.完成。

當(dāng)樣式配置為“ one_or_ordered”時(shí),所有這三個(gè)示例均有效。

有效樣式示例(如果樣式配置為“零”):

0。
0。
0.完成。

所有樣式的無效列表示例:

1.這樣做。
3.完成。

此規(guī)則支持前綴為0的有序列表項(xiàng)以統(tǒng)一縮進(jìn):

...
 08.項(xiàng)目
 09.項(xiàng)目
 10.項(xiàng)目
 11.項(xiàng)目
...

注意:對(duì)于以下情況,此規(guī)則將報(bào)告違規(guī)情況,其中在兩個(gè)列表項(xiàng)之間出現(xiàn)縮進(jìn)的代碼塊(或類似的代碼塊),并在其中“破壞”兩個(gè)列表:

1.第一名單

文字
代碼塊

1.第二清單


解決方法是縮進(jìn)代碼塊,使其按預(yù)期成為前面的列表項(xiàng)的一部分:

```source-gfm
1.第一名單

   文字
   代碼塊

2.仍然是第一名


基本原理:一致的格式設(shè)置使文檔理解更加容易。

## [](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md030---spaces-after-list-markers)MD030-列表標(biāo)記后的空格

標(biāo)簽:ol,ul,空格

別名:列表標(biāo)記空間

參數(shù):ul_single,ol_single,ul_multi,ol_multi(數(shù)字;默認(rèn)值為1)

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

該規(guī)則檢查列表標(biāo)記(例如“ `-`”,“ `*`”,“ `+`”或“ `1.`”)與列表項(xiàng)文本之間的空格數(shù)。

檢查的空格數(shù)取決于使用的文檔樣式,但是默認(rèn)值為任何列表標(biāo)記后的1個(gè)空格:

```source-gfm
* Foo
 *酒吧
 * Baz

1. Foo
 1. Bar
 1. Baz

1. Foo
    * Bar
 1. Baz

文檔樣式可以根據(jù)列表中每個(gè)項(xiàng)目的內(nèi)容是由一個(gè)段落還是由多個(gè)段落(包括子列表和代碼塊)組成,分別更改無序列表項(xiàng)和有序列表項(xiàng)后的空格數(shù))。

例如,https://cirosantilli.com/markdown-style-guide#spaces-after-list-marker上的樣式指南 指定,如果列表中的每個(gè)項(xiàng)目都適合一個(gè)段落,則列表標(biāo)記后應(yīng)使用1個(gè)空格。 ,但如果列表中有多個(gè)內(nèi)容段落,則使用2或3個(gè)空格(分別用于有序列表和無序列表):

* Foo
 *酒吧
 * Baz

*    富

    第二段

*    酒吧

要么

1.   Foo

    第二段

1.   酒吧

要解決此問題,請(qǐng)確保在列表標(biāo)記之后為您選擇的文檔樣式使用了正確的空格數(shù)。

理由:違反此規(guī)則可能會(huì)導(dǎo)致內(nèi)容渲染不正確。

MD031-帶柵欄的代碼塊應(yīng)用空白行包圍

標(biāo)簽:代碼,blank_lines

別名:圍欄周圍的空白

參數(shù):list_items(布爾值;默認(rèn)為true)

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)受防護(hù)的代碼塊之前或之后沒有空行時(shí),將觸發(fā)此規(guī)則:

一些文本

代碼塊


另一個(gè)代碼塊

更多文本

要解決此問題,請(qǐng)確保所有受防護(hù)的代碼塊之前和之后均具有空白行(除非該塊位于文檔的開頭或結(jié)尾):

一些文字

碼塊


的另一個(gè)代碼塊


一些文字

list_items參數(shù)設(shè)置false為禁用此列表項(xiàng)規(guī)則。如果有必要?jiǎng)?chuàng)建包含代碼圍欄的嚴(yán)格列表,則禁用列表的此行為可能很有用 。

基本原理:除了美學(xué)上的原因外,包括kramdown在內(nèi)的某些解析器將不會(huì)解析前后沒有空白行的受防護(hù)的代碼塊。

MD032-列表應(yīng)由空行包圍

標(biāo)簽:項(xiàng)目符號(hào),ul,ol,blank_lines

別名:空白列表

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)(任何種類的)列表不在空行之前或之后時(shí),將觸發(fā)此規(guī)則:

一些文本
 *一些
 *列表

1.一些
 2.清單
一些文字

要解決此問題,請(qǐng)確保所有列表的前后都有空白行(除非該塊位于文檔的開頭或結(jié)尾):

一些文字

*一些
 *清單

1.一些
 2.清單

一些文字

基本原理:除了美學(xué)原因外,包括kramdown在內(nèi)的某些解析器也不會(huì)解析列表前后沒有空白行的列表。

MD033-內(nèi)聯(lián)HTML

標(biāo)簽:HTML

別名:no-inline-html

參數(shù):allowed_elements(字符串?dāng)?shù)組;默認(rèn)為空)

每當(dāng)markdown文檔中使用原始HTML時(shí),都會(huì)觸發(fā)此規(guī)則:

<h1>內(nèi)聯(lián)HTML標(biāo)題</ h1>

要解決此問題,請(qǐng)使用“純”markdown,而不要包含原始HTML:

# markdown標(biāo)題

注意:要允許特定的HTML元素,請(qǐng)使用'allowed_elements'參數(shù)。

基本原理:markdown允許使用原始HTML,但是對(duì)于那些希望其文檔僅包含“純” markdown的人或那些以HTML以外的方式呈現(xiàn)markdown文檔的人來說,此規(guī)則也包括在內(nèi)。

MD034-使用的裸URL

標(biāo)簽:鏈接,URL

別名:裸URL

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

只要給出的URL被尖括號(hào)包圍,就會(huì)觸發(fā)此規(guī)則:

有關(guān)更多信息,請(qǐng)參見https://www.example.com/。

要解決此問題,請(qǐng)?jiān)赨RL周圍添加尖括號(hào):

有關(guān)更多信息,請(qǐng)參見<https://www.example.com/>。

注意:要使用裸URL而不將其轉(zhuǎn)換為鏈接,請(qǐng)將其括在代碼塊中,否則在某些markdown解析器中將對(duì)其進(jìn)行轉(zhuǎn)換:

https://www.example.com

注:以下情形并不會(huì)觸發(fā)此規(guī)則,以避免沖突MD011/ no-reversed-links

[https://www.example.com]

在裸鏈接周圍使用引號(hào)不會(huì)觸發(fā)此規(guī)則,或者:

“ https://www.example.com”
'https://www.example.com'

基本原理:沒有尖括號(hào),許多Markdown解析器不會(huì)將URL轉(zhuǎn)換為鏈接。

MD035-水平尺樣式

標(biāo)簽:小時(shí)

別名:hr樣式

參數(shù):樣式(“ consistent”,“ ---”,“ ***”或其他指定水平線的字符串;默認(rèn)為“ consistent”)

當(dāng)在文檔中使用不一致樣式的水平規(guī)則時(shí),將觸發(fā)此規(guī)則:

---

- - -

***

* * *

****

要解決此問題,請(qǐng)確保文檔中使用的所有水平尺都一致,或者如果配置了此規(guī)則,則匹配給定樣式:

---

---

注意:默認(rèn)情況下,此規(guī)則配置為僅要求文檔中的所有水平規(guī)則都相同,并且如果任何水平規(guī)則與文檔中遇到的第一個(gè)不同,則將觸發(fā)此規(guī)則。如果要配置規(guī)則以匹配特定樣式,則給“樣式”選項(xiàng)提供的參數(shù)是一個(gè)字符串,其中包含允許的確切水平規(guī)則文本。

基本原理:一致的格式設(shè)置使文檔理解更加容易。

MD036-使用強(qiáng)調(diào)代替標(biāo)題

標(biāo)簽:標(biāo)題,標(biāo)題,重點(diǎn)

別名:不強(qiáng)調(diào)標(biāo)題,不強(qiáng)調(diào)標(biāo)題

參數(shù):標(biāo)點(diǎn)符號(hào)(字符串;默認(rèn)為“。,;:!?。,;;:!?”)

此檢查查找使用強(qiáng)調(diào)(即,粗體或斜體)文本分隔各節(jié)的情況,而應(yīng)使用標(biāo)題代替:

**我的文件**

小學(xué)二年級(jí)奧數(shù)試題及答案小學(xué)奧數(shù)網(wǎng)...

_另一節(jié)_

Consectetur adipiscing精英,sed do eiusmod。

要解決此問題,請(qǐng)使用markdown標(biāo)題而不是強(qiáng)調(diào)文本來表示部分:

# 我的文件

小學(xué)二年級(jí)奧數(shù)試題及答案小學(xué)奧數(shù)網(wǎng)...

## 另一部分

Consectetur adipiscing精英,sed do eiusmod。

注意:此規(guī)則將查找完全由強(qiáng)調(diào)文字組成的單行段落。它不會(huì)針對(duì)常規(guī)文本,強(qiáng)調(diào)多行的段落或以標(biāo)點(diǎn)符號(hào)結(jié)尾的段落(普通或全角)使用。與規(guī)則MD026相似,您可以配置將哪些字符識(shí)別為標(biāo)點(diǎn)符號(hào)。

原理:使用強(qiáng)調(diào)代替標(biāo)題可以防止工具推斷文檔的結(jié)構(gòu)。更多信息:https : //cirosantilli.com/markdown-style-guide#emphasis-vs-headers。

MD037-重點(diǎn)標(biāo)記內(nèi)的空格

標(biāo)簽:空格,重點(diǎn)

別名:強(qiáng)調(diào)中沒有空格

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

使用強(qiáng)調(diào)標(biāo)記(粗體,斜體)時(shí)會(huì)觸發(fā)此規(guī)則,但是它們?cè)跇?biāo)記和文本之間有空格:

這是一些**粗體**文本。

這是一些*斜體*文本。

這是____粗體字。

這是更多的_斜體_文本。

要解決此問題,請(qǐng)刪除重點(diǎn)標(biāo)記周圍的空格:

這是一些“ 粗體”文本。

這是一些*斜體*文本。

這是更多的__bold__文本。

這是更多的_italic_文本。

基本原理:僅當(dāng)星號(hào)/下劃線未完全被空格包圍時(shí),才對(duì)強(qiáng)調(diào)進(jìn)行分析。該規(guī)則試圖檢測(cè)它們被空格包圍的位置,但是強(qiáng)調(diào)的文字似乎是作者想要的。

MD038-代碼跨度元素內(nèi)的空格

標(biāo)簽:空格,代碼

別名:代碼中無空格

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

對(duì)于與反引號(hào)相鄰的空格的代碼跨度元素,將觸發(fā)此規(guī)則:

`一些文字`

`一些文字`

要解決此問題,請(qǐng)刪除反引號(hào)附近的所有空格:

一些文字

注意:規(guī)范允許使用單個(gè)前導(dǎo)和尾隨空格,并會(huì)自動(dòng)對(duì)其進(jìn)行修剪(以允許嵌入反引號(hào)):

```反引號(hào)`''

注意:如果用于將代碼跨標(biāo)記與嵌入式反引號(hào)分開,則允許使用單個(gè)前導(dǎo)或尾隨空格:

``嵌入反引號(hào)''

理由:違反此規(guī)則可能會(huì)導(dǎo)致內(nèi)容渲染不正確。

MD039-鏈接文本內(nèi)的空格

標(biāo)簽:空格,鏈接

別名:鏈接中沒有空格

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

在鏈接文本周圍有空格的鏈接上觸發(fā)此規(guī)則:

[ 鏈接 ](https://www.example.com/)

要解決此問題,請(qǐng)刪除鏈接文本周圍的空格:

[ 鏈接 ](https://www.example.com/)

基本原理:一致的格式設(shè)置使文檔理解更加容易。

MD040-帶圍欄的代碼塊應(yīng)指定一種語言

標(biāo)簽:代碼,語言

別名:柵欄代碼語言

使用受防護(hù)的代碼塊但未指定語言時(shí)觸發(fā)此規(guī)則:

#!/ 斌/慶典
回聲世界,你好

要解決此問題,請(qǐng)將語言說明符添加到代碼塊中:

``
#!/ bin / bash 
echo Hello world

基本原理:通過使用正確的代碼語法高亮顯示,指定一種語言可以改善內(nèi)容呈現(xiàn)。更多信息:[https](https://cirosantilli.com/markdown-style-guide#option-code-fenced) : [//cirosantilli.com/markdown-style-guide#option-code-fenced](https://cirosantilli.com/markdown-style-guide#option-code-fenced)。

## [](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md041---first-line-in-file-should-be-a-top-level-heading)MD041-文件中的第一行應(yīng)為頂層標(biāo)題

標(biāo)簽:標(biāo)題,標(biāo)題

別名:first-line-heading,first-line-h1

參數(shù):level,front_matter_title(數(shù)字;默認(rèn)值1,字符串;默認(rèn)值“ ^ \ s * title:”)

該規(guī)則旨在確保文檔具有標(biāo)題,并且在文件的第一行不是頂層(h1)標(biāo)題時(shí)觸發(fā)該規(guī)則:

```source-gfm
這是一個(gè)沒有標(biāo)題的文件

要解決此問題,請(qǐng)將頂級(jí)標(biāo)題添加到文件的開頭:

# 帶有標(biāo)題的文件

這是一個(gè)具有頂級(jí)標(biāo)題的文件

注意: level在外部添加h1的情況下,參數(shù)可用于更改頂層(例如:更改為h2)。

如果存在YAML前件并包含一個(gè) title屬性(通常用于博客文章),則此規(guī)則不會(huì)報(bào)告違規(guī)。要在最前面使用其他屬性名稱,請(qǐng)通過front_matter_title參數(shù)指定正則表達(dá)式的文本。要禁用此規(guī)則使用前的事情,指定""front_matter_title

理由:頂級(jí)標(biāo)題通常充當(dāng)文檔的標(biāo)題。更多信息:https : //cirosantilli.com/markdown-style-guide#top-level-header。

MD042-無空鏈接

標(biāo)簽:鏈接

別名:無空鏈接

遇到空鏈接時(shí)將觸發(fā)此規(guī)則:

[一個(gè)空鏈接]()

要解決違規(guī)問題,請(qǐng)為鏈接提供目標(biāo)位置:

[ 有效鏈接 ](https://example.com/)

空片段將觸發(fā)以下規(guī)則:

[ 一個(gè)空片段 ](#)

但是非空片段不會(huì):

[ 有效片段 ](#fragment)

原理:空鏈接不會(huì)指向任何地方,因此不能用作鏈接。

MD043-所需的標(biāo)題結(jié)構(gòu)

標(biāo)簽:標(biāo)題,標(biāo)題

別名:必填標(biāo)題,必填標(biāo)題

參數(shù):標(biāo)題,標(biāo)題(字符串?dāng)?shù)組;默認(rèn)null為禁用)

如果headings未提供,headers將使用(不推薦使用)。

當(dāng)文件中的標(biāo)題與傳遞給該規(guī)則的標(biāo)題數(shù)組不匹配時(shí),將觸發(fā)此規(guī)則。它可用于對(duì)一組文件強(qiáng)制執(zhí)行標(biāo)準(zhǔn)標(biāo)題結(jié)構(gòu)。

嚴(yán)格要求以下結(jié)構(gòu):

# 頭
## 項(xiàng)目
### 詳細(xì)

headings參數(shù)設(shè)置為:

[
     “#頭”,
     “ ##項(xiàng)”,
     “ ###細(xì)節(jié)” 
]

允許具有以下結(jié)構(gòu)的可選標(biāo)題:

# 頭
## 項(xiàng)目
### 詳細(xì)信息(可選)
## 腳
### 注意(可選)

使用"*"含義為“一個(gè)或多個(gè)未指定標(biāo)題” 的特殊值,并將headings參數(shù)設(shè)置為:

[
     “#Head ”,
     “ ## Item ”,
     “ * ”,
     “ ##腳”,
     “ * ” 
]

當(dāng)檢測(cè)到錯(cuò)誤時(shí),此規(guī)則將輸出第一個(gè)有問題的標(biāo)題的行號(hào)(否則,將輸出文件的最后一個(gè)行號(hào))。

請(qǐng)注意,盡管headings為簡(jiǎn)單起見,該參數(shù)使用“ ## Text” ATX標(biāo)題樣式,但文件可以使用任何受支持的標(biāo)題樣式。

理由:項(xiàng)目可能希望在一組相似的內(nèi)容上實(shí)施一致的文檔結(jié)構(gòu)。

MD044-正確的名字應(yīng)該有正確的大寫

標(biāo)簽:拼寫

別名:專有名稱

參數(shù):名稱,code_blocks(字符串?dāng)?shù)組; default null,boolean; default true

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)names數(shù)組中的任何字符串不具有指定的大寫字母時(shí),將觸發(fā)此規(guī)則。它可以用于對(duì)項(xiàng)目和產(chǎn)品的名稱強(qiáng)制使用標(biāo)準(zhǔn)的大寫字母。

例如,語言“ JavaScript”通常用大寫的“ J”和“ S”書寫,盡管有時(shí)“ s”或“ j”以小寫字母出現(xiàn)。要強(qiáng)制使用大寫字母,請(qǐng)?jiān)?code>names數(shù)組中指定所需的字母大小寫:

[
     “ JavaScript ” 
]

code_blocks參數(shù)設(shè)置false為禁用此規(guī)則的代碼塊。

理由:專有名稱的大寫錯(cuò)誤通常是一個(gè)錯(cuò)誤。

MD045-圖片應(yīng)具有替代文字(替代文字)

標(biāo)簽:輔助功能,圖像

別名:無替代文本

當(dāng)圖像缺少備用文本(替代文本)信息時(shí),將觸發(fā)此規(guī)則。

備用文本通常在內(nèi)聯(lián)中指定為:

![ 替代文字 ](image.jpg)

或使用如下參考語法:

![ 替代文字 ] [ref]

...

[ ref ]:image.jpg“可選標(biāo)題”

W3C, Wikipedia其他位置提供了編寫替代文本的指南。

基本原理:替代文本對(duì)于可訪問性很重要,并為可能看不到它的人們描述了圖像的內(nèi)容。

MD046-代碼塊樣式

標(biāo)簽:代碼

別名:代碼塊樣式

參數(shù):樣式(“ consistent”,“ fenced”,“ indented”;默認(rèn)為“ consistent”)

在同一文檔中使用不需要或不同的代碼塊樣式時(shí),將觸發(fā)此規(guī)則。

在默認(rèn)配置中,此規(guī)則報(bào)告違反以下文檔:

Some text.

    # Indented code

More text.

```ruby
# Fenced code

More text.


要解決違反此規(guī)則的問題,請(qǐng)使用一致的樣式(縮進(jìn)或代碼圍欄)。

指定的樣式可以是特定的()`fenced`,也可以`indented`僅要求文檔中的用法保持一致(`consistent`)。

基本原理:一致的格式設(shè)置使文檔理解更加容易。

## [](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md047---files-should-end-with-a-single-newline-character)MD047-文件應(yīng)以單個(gè)換行符結(jié)尾

標(biāo)簽:blank_lines

別名:?jiǎn)涡袚Q行

可修復(fù):大多數(shù)違規(guī)行為可以通過工具修復(fù)

當(dāng)文件末尾沒有單個(gè)換行符時(shí),將觸發(fā)此規(guī)則。

觸發(fā)規(guī)則的示例:

```source-gfm
# 標(biāo)題

該文件結(jié)尾沒有換行符。[EOF]

要解決違規(guī)問題,請(qǐng)?jiān)谖募┪蔡砑訐Q行符:

# 標(biāo)題

該文件以換行符結(jié)尾。
[EOF]

基本原理:某些程序?qū)τ谖匆該Q行符結(jié)尾的文件有麻煩。更多信息:https : //unix.stackexchange.com/questions/18743/whats-the-point-in-adding-a-new-line-to-the-end-of-a-file。

MD048-代碼圍欄樣式

標(biāo)簽:代碼

別名:柵欄樣式

參數(shù):樣式(“ consistent”,“ tilde”,“ backtick”;默認(rèn)為“ consistent”)

當(dāng)文檔中用于受防護(hù)代碼塊的符號(hào)與配置的代碼防護(hù)樣式不匹配時(shí),將觸發(fā)此規(guī)則:

紅寶石
#圍欄代碼
#圍欄代碼

要解決此問題,請(qǐng)?jiān)谡麄€(gè)文檔中使用配置的代碼圍欄樣式:

```source-gfm
紅寶石
#圍欄代碼

紅寶石
#圍欄代碼

配置的列表樣式可以是要使用的特定符號(hào)(反引號(hào),波浪號(hào)),也可以要求文檔中的用法必須一致。

基本原理:一致的格式設(shè)置使文檔理解更加容易。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容