Offline export
Export your documentation site as a self-contained zip archive for offline viewing, internal distribution, or air-gapped environment hosting.
Use mint export to package your entire documentation site into a self-contained zip archive. Recipients can unzip and view the docs in their browser without an internet connection, 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, air-gapped environments, or internal compliance reviews.
Prerequisites
Section titled “Prerequisites”Limitations
Section titled “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.
Export your site
Section titled “Export your site”Navigate to your documentation directory containing your docs.json file and run:
mint exportThe CLI builds your site, crawls every page defined in your navigation, and packages the output into a zip file in your current directory.
Options
Section titled “Options”| Flag | Description | Default |
|---|---|---|
--output <path> |
Set the output zip file path. | export.zip |
--groups <group> |
Mock user groups for the export. Useful when your docs use group-based access control and you want the archive to include restricted pages. | — |
--disable-openapi |
Skip OpenAPI file generation during the export. Use this if you have many OpenAPI specs and want faster builds. | — |
For example, to export your site to a custom filename with a specific user group:
mint export --output customer-docs.zip --groups enterpriseSecurity considerations
Section titled “Security considerations”The exported archive is a static, unauthenticated bundle. Anyone with the zip file can view every page it contains.
- The
--groupsflag 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
Section titled “What's in the zip”The exported archive contains everything needed to view your docs offline:
| File | Purpose |
|---|---|
| HTML pages | Pre-rendered version of every page in your navigation |
_next/static/ |
Bundled CSS, JavaScript, and other static assets |
serve.js |
Zero-dependency Node.js HTTP server that serves the site |
Start Docs.command |
macOS launcher. Double-click to open the docs. |
Start Docs.bat |
Windows launcher. Double-click to open the docs. |
View the exported docs
Section titled “View the exported docs”Share the zip file with anyone who has Node.js installed. To view the docs:
- Unzip the archive.
- Open a terminal in the unzipped directory.
- Run
node serve.js. - Open
http://localhost:3000in your browser.
- Unzip the archive.
- Double-click Start Docs.command.
- The docs open in your default browser at
http://localhost:3000.
- Unzip the archive.
- Double-click Start Docs.bat.
- The docs open in your default browser at
http://localhost:3000.