离线导出需要 Enterprise 方案。
mint export 将整个文档站点打包成一个包含预渲染页面的 zip 归档文件。收件人可以解压后在浏览器中查看文档,无需 Mintlify 账户或任何构建工具。只需安装 Node.js 即可。
当你需要向无法访问线上站点的用户分发文档时(例如本地部署客户或内部合规审查),这非常有用。
导出内容并非完全自包含。部分资源会在运行时从外部主机加载,并且导出内容必须从域名根路径提供服务。隔离网络(air-gapped)环境,以及在其他应用内或子路径下托管导出内容,均未获得完全支持。在将导出内容部署到无法访问互联网的环境之前,请查看限制。
前提条件
限制
- 离线导出不支持搜索。如需添加离线搜索,请使用静态搜索工具为导出的 HTML 建立索引。
- 离线导出不支持 Mintlify 助手。
- 离线导出必须从域名根路径提供服务,例如
http://localhost:3000/。不支持在子路径(例如/docs)下提供导出内容。 - 部分资源会在运行时从外部主机加载。在没有互联网访问,或内容安全策略(Content Security Policy)阻止这些主机的情况下,这些资源将无法加载。
从外部主机加载的资源
导出你的站点
docs.json 文件的文档目录,然后运行:
选项
例如,要将站点导出为自定义文件名并指定用户组:
导出仅包含导航中列出的页面。隐藏页面 不会包含在归档中。
安全注意事项
--groups标志用于控制在导出时 Mintlify 将哪些受用户组限制的页面包含到归档中。它不会在导出后强制执行认证。- 只与被允许查看归档内容的收件人分享归档文件。
- 若要发布新的更改,请重新生成并重新分发归档—使用旧 zip 的收件人将继续看到旧的内容。
zip 中的内容
查看导出的文档
- 手动
- macOS
- Windows
- 解压归档文件。
- 在解压后的目录中打开终端。
- 运行
node serve.js。 - 在浏览器中打开
http://localhost:3000。