首页 > 解决方案 > 如何保存(不部署)mkdocs 以在本地浏览 HTML?

问题描述

mkdocs是否可以在框架内创建某些项目的文档?

我知道通过mkdocs serve. 我们也可以在文档达到我们喜欢执行的某个级别mkdocs build时创建一个site文件夹,实际上我们可以在本地下载该文件夹并通过打开 index.html 文件进行浏览。

然而,这种方法并不完美,因为每次我们可以切换标签时,它都会进入一个中间步骤,我们必须手动匹配另一个我们感兴趣的 HTML 页面。

是否可以保存整个mkdocs本地或保存为pdf?它必须供本地使用,但没有服务器方法。

标签: htmldocumentationmkdocs

解决方案


根据文档mkdocs.yml,您可以在配置文件中设置此值:

site_url: ""
use_directory_urls: False

site_url如果要使用file://方案,必须将其设置为空字符串。

use_directory_urls应该设置false为页面之间的链接正常工作。

您还需要禁用搜索插件或使用其他支持file://方案的插件。

注意:并非每个主题都能在离线模式下正常显示


推荐阅读