Skip to content

构建优化网站

默认情况下,MkDocs 的 Material 允许构建在搜索引擎上排名良好、加载快速(即使在慢速网络上)并且在没有 JavaScript 的情况下完美运行的优化网站。此外,内置优化插件 增加了对进一步有用的自动优化技术的支持。

配置

内置项目插件

9.7.0 projects – built-in

内置项目插件允许将文档拆分为多个独立的 MkDocs 项目,并行构建一起提供服务。在 mkdocs.yml 中添加以下内容:

plugins:
  - projects

有关所有设置的列表,请参阅 插件文档

项目插件的用例

项目插件的理想用例包括:

  • 构建多语言网站
  • 在文档旁边构建博客
  • 拆分大型代码库以提高性能

请注意,该插件目前处于实验阶段。我们提前发布它,以便与用户一起改进,并在发现新用例时使其更强大。

范围

8.0.0

可能存在一种用例,您希望在所有项目中共享用户级设置,例如所选的 颜色调色板Cookie 同意。为此,请在 mkdocs.yml 中添加以下行:

extra:
  scope: /

它是如何工作的

假设您有以下网站结构:

.
└── /
    ├── subsite-a/
    ├── subsite-b/
    └── subsite-c/
默认情况下,每个站点将具有自己的范围(/subsite-a//subsite-b//subsite-c/)。要修改此行为,请在 mkdocs.yml 中添加以下行:

extra:
  scope: /

将其设置为 /,应该允许您在主站点和所有子站点之间共享以下偏好设置:

内置优化插件

9.7.0 optimize – built-in

内置优化插件会自动识别并优化所有媒体文件,作为构建的一部分,使用压缩和转换技术。在 mkdocs.yml 中添加以下行:

plugins:
  - optimize

有关所有设置的列表,请参阅 插件文档