Skip to content

离线使用构建

如果您希望将文档与产品一起发布,MkDocs 可以满足您的需求——通过主题支持,MkDocs 支持构建离线可用的文档。值得注意的是,Material for MkDocs 为其许多功能提供离线支持。

配置

内置离线插件

9.0.0 offline – built-in

内置的离线插件确保在您将 站点目录 的内容作为下载分发时,站点搜索 可以正常工作。只需将以下行添加到 mkdocs.yml 中:

plugins:
  - offline

有关所有设置的列表,请参考 [插件文档]。

自动打包所有外部资源

内置隐私插件 使得在构建离线使用的文档时,使用外部资源变得简单,因为它会自动下载所有外部资源以便与您的文档一起分发。

限制

Material for MkDocs 提供许多交互式功能,其中一些由于现代浏览器的限制将无法从文件系统中工作:所有使用 fetch API 的功能都会出错。

因此,在为离线使用构建时,请确保禁用以下配置设置:即时加载站点分析git 仓库版本控制评论系统