Markdown linter - mdlint

运行 mdlint

fx mdlint -root-dir $FUCHSIA_DIR/docs

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

如果由于某种原因它不属于当前的 build 配置,请重新运行 fx set,包括用于构建 mdlint 的选项:--with //tools/mdlint

Markdown linter 检查 Markdown:

不良标头

  • 每个文件有一个 H1 头文件。
  • 正确嵌套了子标题级别。
  • 标题重复。

不良列表

  • 在列表前后添加换行符。

锚点大小写

  • 锚点必须为小写。

newline-before-围栏代码块

  • 在围栏代码块前后换行。

文档开头没有额外空间

  • 文档开头没有空白行。

右侧无额外空格

  • 结尾不得有空格。

尊重列长度

  • 每行不能超过 80 个字符。

尊重代码

鼓励在文档中使用尊重的用语。请参阅在 mdlint 中修改非包含性字词

简单 utf8 字符

避免使用可以在 ASCII 中表示的 UTF-8 字符。

  • '