Skip to content

为离线使用构建

如果你想将你的文档与你的产品一起提供,MkDocs 可以帮助你 - 通过主题的支持,MkDocs允许构建可以离线使用的文档。值得注意的是,Material for MkDocs 为其许多功能提供了离线支持。

配置

内置离线插件

离线支持 · 插件

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

plugins:
  - offline

插件将自动禁用use_directory_urls设置,确保用户可以直接从本地文件系统打开你的文档。

以下配置选项可用:

enabled

默认值:true - 此选项指定在构建项目时是否启用插件。如果你想关闭插件,例如,对于本地构建,使用环境变量

``` yaml
plugins:
  - offline:
      enabled: !ENV [OFFLINE, false]
```

现在,在调用mkdocs build之后,你可以直接在浏览器中打开site/index.html站点搜索将像在常规服务器上托管的文档一样工作。

自动捆绑所有外部资产

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

限制

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

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