MkDocs Redoc Tag

MkDocs插件，支持在页面中添加Redoc。

功能

1. 从在线URL或docs中的静态文件获取OpenAPI规范文件
2. 所有依赖项都使用由插件处理的静态文件，而不是CDN，特别适合那些在内部网络中部署的文档
3. 与Material for MkDocs同步的暗黑模式

依赖项

1. Python包
   1. beautifulsoup4>=4.11.1
2. 来自官方CDN的独立Redoc JavaScript
   1. redoc==2.1.3

用法

1. 从PyPI安装插件

   pip install mkdocs-redoc-tag
   

2. 将redoc-tag插件添加到mkdocs.yml的plugins部分

   plugins:
      - redoc-tag
   

3. 在markdown中添加redoc标签以包含Redoc

   <redoc src="https://petstore.swagger.io/v2/swagger.json"/>
   

   

4. 您可以通过在mkdocs.yml中传递选项来自定义插件

   plugins:
      - redoc-tag:
           background: White
   

   选项	类型	描述
   background	字符串	默认：""。Redoc iframe body背景属性值。您可以使用任何CSS值作为背景，例如"#74b9ff"或"Gainsboro"或""为无。
   height	字符串	默认："80vh"。Redoc iframe的高度。

工作原理

1. 将Redoc脚本文件复制到site/assets/javascripts/目录
2. 搜索所有redoc标签，然后将它们转换为iframe标签，并使用给定的OpenAPI规范src路径生成iframe目标HTML

许可证

本项目采用MIT许可证 - 有关详细信息，请参阅LICENSE.md文件。

参考

1. redark：暗黑模式javascript和css的来源