mkdocstrings-shell

mkdocstrings的shell脚本/库处理器。它使用Shellman从shell脚本中收集文档。

安装

此项目仅对赞助商可用，通过我的Insiders计划。请参阅Insiders 说明 和 安装说明。

配置

在MkDocs配置文件中

plugins:
- mkdocstrings:
    default_handler: shell  # optional

该处理器目前不提供任何选项。

用法

使用mkdocstrings语法为脚本注入文档

::: relative/path/to/script
    handler: shell  

如果您在mkdocs.yml中将shell声明为默认处理器，则指定handler: shell是可选的。