Markdown Linter - mdlint

執行 mdlint

fx mdlint -root-dir $FUCHSIA_DIR/docs

如需更多選項,請參閱完整的指令列參考資料

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

Markdown Linter 檢查 Markdown:

標題不佳

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

不良清單

  • 在清單前後加上換行符號。

錨定大小寫

  • 錨點必須為小寫。

換行前程式碼區塊

  • 圍欄程式碼區塊前後的換行符號

起始文件的無額外空格

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

右側沒有額外空格

  • 結尾不得為空格。

尊重-欄長度

  • 80 個半形字元,

尊重程式碼

說明文件中的用語請保持尊重的態度。請參閱「修改 mdlint 中不含包容的字詞」。

Simple-utf8-chars

請避免使用 ASCII 中顯示的 utf-8 字元。

  • '