内置插件¶
Material for MkDocs 最初是 MkDocs 的一个主题,但现在已经发展成为一个完整的文档构建和维护框架。主题仍然是项目的核心,但现在伴随着越来越多的互补内置插件。
我们努力使这些插件尽可能模块化和通用,以便可以在各种项目和用例中使用。通过提供有用的默认设置,我们还尝试使它们尽可能易于使用,以便您可以快速开始,稍后再调整其设置。在开发内置插件时,我们始终遵循以下设计原则:
-
模块化: 内置插件设计为模块化,以便可以轻松组合以实现复杂的管道。例如,offline、optimize 和 privacy 插件可以一起使用,以构建真正的 offline-capable documentation。
-
互操作性: 内置插件设计为尽可能兼容,以便可以与其他插件(包括第三方插件)结合使用。我们努力使其与围绕 MkDocs 发展起来的庞大生态系统的集成变得简单。
-
性能: 内置插件设计为尽可能快速和内存高效,以免不必要地减慢构建速度。这对于拥有数千页的大型文档项目尤其重要。
分类¶
管理¶
以下插件通过提供更好的管理能力,极大地改善了在文档项目中工作的创作体验,从插件管理、多个项目和元数据管理,到为错误报告创建最小重现:
-
组插件允许将插件分组为逻辑单元,以便在特定环境中有条件地启用或禁用它们,使用 环境变量。
在不同环境中构建时对插件的最佳管理
-
元插件使得管理文件夹中所有页面的元数据(前置信息)变得简单,因此某个子集的页面可以使用特定标签或自定义模板。
更简单的元数据组织、分类和管理
-
项目插件允许将您的主项目拆分为多个独立项目,能够并行构建并将它们作为一个整体预览。
将多个项目连接在一起,可以单独构建或作为一个整体构建
-
信息插件是一个小而有用的工具,帮助创建自包含的最小重现,以便我们维护者可以更快地修复报告的错误。
您的错误报告质量最高,因此我们可以尽快修复它们
优化¶
以下插件旨在帮助您构建优化的文档,使其通过更快的加载时间、更好的搜索引擎排名、社交媒体上的美丽预览图像以及通过几行配置实现 GDPR 合规性,使用户更易于访问:
-
社交插件自动为您文档的每个页面生成美丽且可自定义的社交卡片,在社交媒体上显示为预览。
链接到您的网站在社交媒体上共享时呈现美丽的社交卡片
-
优化插件自动识别并优化您在项目中引用的所有媒体文件,使用压缩和转换技术。
您的网站加载更快,因为更小的图像被提供给您的用户
-
隐私插件自动下载外部资源以便于自托管,通过一行配置实现 GDPR 合规性。
您的文档可以在最小努力下实现 GDPR 合规性
-
离线插件增加对构建 offline-capable documentation 的支持,因此您可以将
site目录 作为.zip文件分发,供下载。
您的文档可以在没有互联网连接的情况下工作
内容¶
以下插件旨在帮助您设置博客,为用户提供搜索功能,为页面和帖子添加标签,并在文档的特定部分使用与主内容相同的排版功能:
架构¶
多个实例¶
几个内置插件支持多个实例,这意味着它们可以在同一配置文件中多次使用,从而允许为项目的不同部分微调行为。目前,以下插件支持多个实例: