mkdocs-code-validator

检查MkDocs站点中的Markdown代码块与用户定义的操作

pip install mkdocs-code-validator

使用方法

在 mkdocs.yml 中激活插件。 identifiers 配置是必须的。并且插件 没有 pymdownx.superfences 将无法工作。

plugins:
  - search
  - code-validator:
      identifiers:
        bash:
          validators:
            - grep a
markdown_extensions:
  - pymdownx.superfences

上述配置检查了该MkDocs站点的Markdown文件中的每个 ```bash 代码块必须包含字母 "a"，否则将出现警告。

每个代码块的内容都作为stdin传递给命令。检查的是命令的退出代码：非零代码将产生警告（在MkDocs中，您可以使用 --strict 标志将其设置为致命）。命令的输出不被用于任何方式，仅作为警告的一部分保留在屏幕上。

您可以添加任意数量的标识符，并在其中添加任意数量的 validators 命令，每个命令都有产生警告的能力。

如果您的命令无法使用stdin，则可以使用临时文件来传递输入——这是在命令中包含确切参数$<（然后替换为文件路径）时执行的。对于上述示例，将命令更改为grep a $<是等效的（除了技术细节）。

这些命令不允许使用自由形式的shell语法，它只是调用具有其参数的一个子进程。要显式选择shell，只需运行它（例如）sh -c 'if grep a; then exit 1; fi'。或者，使用临时文件：sh -c 'if grep a "$1"; then exit 1; fi' $<。

代码块的定义完全根据pymdownx.superfences扩展。必须启用它；没有它，插件不会执行任何操作。