Markdown linter - mdlint

运行 mdlint

fx mdlint -root-dir $FUCHSIA_DIR/docs

如需了解更多选项,请参阅完整的命令行参考

如果由于某种原因不属于当前 build 配置,请重新运行 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 中非包含性字词

简单 UTF-8 字符

避免使用可以用 ASCII 表示的 utf-8 字符。

  • '