离线导出

将你的文档站点导出为自包含的 zip 归档文件，用于离线查看和分发。

使用 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 中的内容

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

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

​

查看导出的文档

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

手动

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

macOS

1. 解压归档文件。
2. 双击 Start Docs.command。
3. 文档会在默认浏览器中打开，地址为 http://localhost:3000。

macOS 可能会因为文件是从互联网下载的而阻止运行。如果看到安全警告，请前往系统设置 > 隐私与安全性，然后选择仍要打开。详情请参阅 Apple 的安全设置覆盖指南。

Windows

1. 解压归档文件。
2. 双击 Start Docs.bat。
3. 文档会在默认浏览器中打开，地址为 http://localhost:3000。

Windows 可能会显示”Windows 已保护你的电脑”警告，因为该文件是从互联网下载的。选择更多信息，然后选择仍要运行。