【问题标题】:How to save (not deploy) mkdocs to browse in HTML locally?如何保存(不部署)mkdocs 以在本地浏览 HTML?
【发布时间】:2021-12-19 00:13:21
【问题描述】:

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

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

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

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

【问题讨论】:

    标签: html documentation mkdocs


    【解决方案1】:

    根据documentation,可以在mkdocs.yml配置文件中设置这个值:

    site_url: ""
    use_directory_urls: False
    

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

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

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

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

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2019-03-27
      • 2014-10-26
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2020-03-02
      • 2018-04-18
      • 2012-05-11
      相关资源
      最近更新 更多