Skip to content
Mintlify
Mintlify
部署

离线导出

将文档站点导出为自包含的 zip 压缩包,用于离线查看、内部分发或隔离环境托管。

离线导出需要 Enterprise 方案

使用 mint export 将整个文档站点打包成一个自包含的 zip 归档文件。收件人可以解压后在浏览器中查看文档,无需互联网连接、Mintlify 账户或任何构建工具—只需安装 Node.js 即可。

当你需要向无法访问线上站点的用户分发文档时(例如本地部署客户、隔离网络环境或内部合规审查),这非常有用。

  • 已安装并更新至最新版本的 CLI
  • 已安装 Node.js v20.17.0+

进入包含 docs.json 文件的文档目录,然后运行:

mint export

CLI 会构建你的站点,抓取导航中定义的所有页面,并将输出打包为当前目录下的 zip 文件。

标志说明默认值
--output <path>设置输出 zip 文件的路径。export.zip
--groups <group>为导出模拟用户组。当你的文档使用基于组的访问控制,并且你希望归档文件包含受限页面时,此选项非常有用。
--disable-openapi在导出过程中跳过 OpenAPI 文件生成。如果你有大量 OpenAPI 规范并且希望加快构建速度,请使用此选项。

例如,要将站点导出为自定义文件名并指定用户组:

mint export --output customer-docs.zip --groups enterprise

导出仅包含导航中列出的页面。隐藏页面 不会包含在归档中。

导出的归档是一个静态、无需认证的压缩包。任何持有该 zip 文件的人都可以查看其中包含的每个页面。

  • --groups 标志用于控制在导出时 Mintlify 将哪些受用户组限制的页面包含到归档中。它不会在导出后强制执行认证。
  • 只与被允许查看归档内容的收件人分享归档文件。
  • 若要发布新的更改,请重新生成并重新分发归档—使用旧 zip 的收件人将继续看到旧的内容。

导出的归档包含离线查看文档所需的一切:

文件用途
HTML 页面导航中每个页面的预渲染版本
_next/static/打包的 CSS、JavaScript 和其他静态资源
serve.js零依赖的 Node.js HTTP 服务器,用于提供站点服务
Start Docs.commandmacOS 启动器—双击即可打开文档
Start Docs.batWindows 启动器—双击即可打开文档

将 zip 文件分享给任何安装了 Node.js 的人。要查看文档:

  1. 解压归档文件。
  2. 在解压后的目录中打开终端。
  3. 运行 node serve.js
  4. 在浏览器中打开 http://localhost:3000
Was this page helpful?Suggest editsRaise issue