MkDocs配置build_plantuml插件时mkdocs.yml报配置/解析错误如何解决

问题原因 #

你的报错完全由两处错误导致：

• YAML语法不符合MkDocs插件的配置规范：build_plantuml下的参数是键值映射格式，你错误给每个参数前加了列表标记-，导致YAML解析器无法正确识别配置结构，触发解析报错。
• bin_path配置错误：该参数需要指向plantuml的可执行文件路径，你当前填的是站点根目录，后续即使语法修正也会无法调用本地渲染。

修正后的配置 #

将你原配置的plugins段替换为以下内容即可：

plugins:
  - search
  - build_plantuml:
      render: local # 本地渲染填local，云端渲染填server
      bin_path: /home/igor/mksite/plantuml.jar # 替换为你实际的plantuml.jar路径，使用server渲染时可忽略该参数
      server: http://www.plantuml.com/plantuml # 官方PlantUML服务器地址，仅server渲染时生效
      output_format: svg # 可选值png/svg
      diagram_root: docs/diagrams # 必须放在docs_dir对应的目录下
      output_folder: out
      input_folder: src
      input_extensions: puml # 多后缀用英文逗号分隔，默认会解析所有文件

额外注意事项 #

如果使用本地渲染，需要提前在你的设备上安装Java环境，并且下载plantuml.jar文件放到你指定的bin_path路径下。

内容的提问来源于stack exchange，提问作者Igor Shakhbazyan