Markdown Linter - mdlint

執行 mdlint

fx mdlint -root-dir $FUCHSIA_DIR/docs

如要進一步瞭解這些選項,請參閱完整指令列參考資料

如果因故不屬於目前建構設定的一部分,請重新執行 fx set 包括建構 mdlint 的選項:--with //tools/mdlint

Markdown Linter 檢查 Markdown:

錯誤標題

  • 每個檔案一個 H1 標頭。
  • 正確的子標題層級巢狀結構。
  • 標題重複。

壞清單

錨定廣告

  • 錨點必須為小寫。

newline-before-fenced-code-block

  • 在圍欄程式碼區塊前後加上換行符號。

no-extra-space-at-start-of-doc

  • 文件開頭不得有空白行。

no-extra-space-on-right

  • 結尾不得為空格。

尊重變長

  • 長度為 80 個半形字元。

尊重碼

在說明文件中提及請尊重他人的用語。詳情請見 修改 mdlint 中非包容性的字詞

簡易 utf8 個字元

避免使用能以 ASCII 表示的 utf-8 字元。

  • '