内置插件¶
Material MkDocs 最初是 MkDocs 的一个主题,目前已发展成为一个用于构建和维护文档的成熟框架。该主题仍然是该项目的核心,且具备了越来越多的内置插件。
Material MkDos 尽可能地让这些插件模块化和通用化,以便能在各种项目和案例中应用。通过一些默认设置,使得整个框架的易用性大大提升,用户可以快速上手搭建一个网站,只需要调整其设置参数就能达到自己想要的效果。在开发内置插件时,我们始终遵循以下设计原则:
-
模块化:Material MkDocs 内置插件都采用模块化设计,因此我们可以轻松组合以实现复杂的管道。例如,离线、优化和 隐私插件可以一起使用来构建真正的离线文档。
-
兼容性:Material MkDocs 内置插件被设计为与 MkDocs 庞大的生态系统尽可能兼容,因此可以与其他插件(包括第三方插件)结合使用。
-
性能:Material MkDocs 内置插件具备尽可能快速且内存高效的特性,所以它们并不会减慢构建速度,这对于包含数千页的大型文档项目尤其重要。
1. 类别¶
1.1 管理¶
以下插件通过提供更好的管理功能,从插件、多个项目和元数据的管理到为错误报告创建最少的复制品),极大地改善了构建文档项目时的创作体验:
-
组别插件允许将插件分组为逻辑单元,以便使用环境变量 有条件地为特定环境启用或禁用它们。
在不同环境中构建时对插件进行优化管理
-
元插件可以轻松管理文件夹中所有页面的元数据,因此一些页面子集可以使用特定标签或自定义模板。
更简单的元数据组织、分类和管理
-
项目插件允许将主项目拆分为多个不同的项目,这些项目可以同时构建,且能够作为一个项目一起预览。
将多个项目连接在一起,并单独或作为一个项目进行构建
-
信息插件是一个小而有用的实用程序,有助于创建自包含的最小复制品,因此维护人员可以更快地修复报告的错误。
错误报告质量的优先级最高,因此我们可以尽快修复它们
1.2 优化¶
Material MkDocs 插件提供了更快的加载速度、更好的搜索引擎排名、社交媒体上漂亮的预览图像以及通过几行配置就能实现 GDPR 合规性,帮助我们构建优化的文档,易于用户进行阅读: