导航菜单

插件生态

常用插件

  • search:内置搜索,Material 已默认包含。
  • mkdocs-material-extensions / pymdown-extensions:增强 Markdown(提示、Tab、代码注释)。
  • mkdocs-awesome-pages-plugin:自动根据目录生成导航。
  • mkdocs-git-revision-date-localized-plugin:显示最后更新时间。
  • mkdocs-minify-plugin:压缩输出。
  • mkdocs-swagger-ui-tag:嵌入 Swagger 文档。
  • mkdocs-multirepo-plugin:聚合多仓库文档。

版本化与多语言

  • 可用 mike(版本部署管理)与 mkdocs-static-i18n 组合实现。
  • 版本下拉可与 Material 配合,或自定义导航。

配置示例

plugins:
  - search
  - git-revision-date-localized
  - minify
  - awesome-pages
markdown_extensions:
  - admonition
  - pymdownx.tabbed
  - pymdownx.highlight

搜索