Skip to main content
Offline exports require an Enterprise plan.
Use mint export to package your entire documentation site into a zip archive of pre-rendered pages. Recipients can unzip and view the docs in their browser without a Mintlify account or any build tools. They only need Node.js installed. This is useful when you need to distribute documentation to users who can’t access your live site, such as for on-premise customers or internal compliance reviews. Exports are not fully self-contained. Some assets load from external hosts at runtime, and exports must be served from the root of a domain. Air-gapped environments, and hosting an export inside another application or under a subpath, are not fully supported. Review the limitations before you deploy an export to an environment without internet access.

Prerequisites

  • The CLI installed and up to date
  • Node.js v20.17.0+ installed

Limitations

  • Offline exports do not support search. To add offline search, index the exported HTML with a static search tool.
  • Offline exports do not support the Mintlify assistant.
  • Offline exports must be served from the root of a domain, such as http://localhost:3000/. Serving an export under a subpath, such as /docs, is not supported.
  • Some assets load from external hosts at runtime. Without internet access, or behind a Content Security Policy that blocks these hosts, they fail to load.

Assets that load from external hosts

Export your site

Navigate to your documentation directory containing your docs.json file and run:
The CLI builds your site, crawls every page defined in your navigation, and packages the output into a zip file in your current directory.

Options

For example, to export your site to a custom filename with a specific user group:
The export only includes pages listed in your navigation. Hidden pages are not included in the archive.

Security considerations

The exported archive is a static, unauthenticated bundle. Anyone with the zip file can view every page it contains.
  • The --groups flag controls which group-restricted pages Mintlify includes in the archive at export time. It does not enforce authentication after export.
  • Only share archives with recipients who are allowed to see the content they contain.
  • Regenerate and redistribute the archive to publish new changes. Anyone running an older zip continues to see the older content.

What’s in the zip

The exported archive contains your pre-rendered pages, their bundled assets, and a server to view them:

View the exported docs

Share the zip file with anyone who has Node.js installed. To view the docs:
  1. Unzip the archive.
  2. Open a terminal in the unzipped directory.
  3. Run node serve.js.
  4. Open http://localhost:3000 in your browser.