You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何不部署mkdocs仅将其导出为本地可离线浏览的HTML或PDF格式?

MkDocs 离线文档导出解决方案

完全可以实现无需启动服务端的离线浏览,以下是两种可直接落地的方案:

方案一:优化原生离线HTML体验(保留全部网页交互效果)

你遇到的切换页面需要手动匹配HTML文件的问题,是因为MkDocs默认生成的是站点路由格式的路径,修改配置即可修复:

  • 打开项目根目录下的mkdocs.yml配置文件
  • 添加或修改use_directory_urls参数为false,参考配置如下:
    site_name: 你的项目文档名称
    use_directory_urls: false
    # 其余原有配置不需要改动
    
  • 重新执行mkdocs build生成新的site文件夹
  • 直接打开site文件夹内的index.html即可正常通过导航栏切换所有页面,所有资源均为本地离线加载,无需启动任何服务。

方案二:导出为单PDF文件(适合分发、归档场景)

可以通过MkDocs插件直接生成整合所有内容的PDF文件:

  • 首先执行命令安装PDF导出插件:pip install mkdocs-pdf-export-plugin
  • 在mkdocs.yml中添加插件配置:
    plugins:
      - search
      - pdf-export:
          combined: true
    
  • 执行mkdocs build后,site文件夹下会生成完整的整合PDF文件,自带目录跳转能力,直接打开即可离线浏览。
    如果需要调整PDF的排版、字体、页眉页脚等格式,可以在插件配置项中自定义对应参数即可

内容的提问来源于stack exchange,提问作者Petr

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.09.28 00:18:03