跳转至

MKDocs 插件列表

预计阅读时长 : 2 分钟

系统

导航

  • meta ⧉ : 针对单个文件或者整个文件夹设置元数据
  • tags ⧉ : 通过为页面添加标签,可以将相关页面分组,并通过搜索和专用标签索引使其易于发现
  • typeset ⧉ : 保留导航和目录中的 HTML 格式,支持代码块、图标、表情符号和其他行内格式
  • enumerate-headings ⧉ : 为正文中的标题自动增加编号
  • awesome-pages ⧉ : 在每个目录中单独自定义导航插件,需要取消配置文件中的 nav 部分内容,与 insider 版本冲突
  • mkdocs-literate-nav ⧉ : 使用 Markdown 格式的导航目录文件取代配置文件中的 YAML 导航,与 insider 版本冲突
  • mkdocs-section-index ⧉ : 允许点击部分链接到索引页面,与 insider 版本冲突

样式

代码

  • macros ⧉ : 通过创建可引用的变量和宏命令在 build 命令时执行相应的操作
  • mkdocs-gen-files ⧉ : 自动创建文件插件,可以自定义一个 Python 函数生成对应的文件
  • markdown-exec ⧉ : 直接执行代码引用块,可选择输出源代码和执行结果
  • mkdocs-jupyter ⧉ : 在文档中直接执行 Jupyter,可进行交互和结果展示
  • mkdocs-swagger-ui-tag ⧉ : 在页面上直接展示 OpenAPI 交互界面