From ea95dfd1da288ee6162f247127b2a9d339c92c2a Mon Sep 17 00:00:00 2001 From: Kyle Finken Date: Fri, 20 Mar 2026 15:30:46 -0700 Subject: [PATCH 1/2] mint export title --- deploy/export.mdx | 72 +++++++++++++++++++++++++++++++++++++++++++++++ docs.json | 1 + installation.mdx | 10 +++++++ 3 files changed, 83 insertions(+) create mode 100644 deploy/export.mdx diff --git a/deploy/export.mdx b/deploy/export.mdx new file mode 100644 index 000000000..f4dae599d --- /dev/null +++ b/deploy/export.mdx @@ -0,0 +1,72 @@ +--- +title: "Offline export" +description: "Export your documentation site as a self-contained zip archive for offline viewing and distribution." +keywords: ["export", "offline", "zip", "static site", "distribution", "mint export"] +--- + +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](https://nodejs.org) 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 + +- The [CLI](/installation) installed and up to date +- [Node.js](https://nodejs.org) v20.17.0+ installed + +## Export your site + +Navigate to your documentation directory containing your `docs.json` file and run: + +```bash +mint export +``` + +The CLI builds your site, crawls every page defined in your navigation, and packages the output into a zip file in your current directory. + +{/* TODO: Confirm exact output filename and whether it's configurable */} + +## 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 + +Share the zip file with anyone who has Node.js installed. To view the docs: + + + + 1. Unzip the archive. + 2. Double-click **Start Docs.command**. + 3. The docs open in your default browser at `http://localhost:3000`. + + + macOS Gatekeeper may block the file because it was downloaded from the internet. To allow it, right-click (or Control-click) **Start Docs.command** and select **Open**, then select **Open** again in the confirmation dialog. You only need to do this once per file. + + + + 1. Unzip the archive. + 2. Double-click **Start Docs.bat**. + 3. The docs open in your default browser at `http://localhost:3000`. + + + Windows SmartScreen may block the file because it was downloaded from the internet. You can unblock it in one of two ways: + + - **From the SmartScreen prompt**: Select **More info**, then select **Run anyway**. + - **From file properties**: Right-click **Start Docs.bat**, select **Properties**, check the **Unblock** checkbox in the Security section, then select **Apply**. + + + + 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. + + diff --git a/docs.json b/docs.json index 0d53e0a0d..67d5fc72c 100644 --- a/docs.json +++ b/docs.json @@ -159,6 +159,7 @@ "pages": [ "deploy/deployments", "deploy/preview-deployments", + "deploy/export", { "group": "/docs subpath", "root": "deploy/docs-subpath", diff --git a/installation.mdx b/installation.mdx index abf0159c6..83932cd5c 100644 --- a/installation.mdx +++ b/installation.mdx @@ -276,6 +276,16 @@ mint migrate-mdx This command converts individual MDX endpoint pages to autogenerated pages defined in your `docs.json`, moves MDX content to the `x-mint` extension in your OpenAPI specification, and updates your navigation. See [Migrating from MDX](/guides/migrating-from-mdx) for detailed information. +### Export for offline viewing + +Export your entire documentation site as a self-contained zip archive for offline viewing and distribution: + +```bash +mint export +``` + +See [Offline export](/deploy/export) for details on using and distributing the exported archive. + ### Import content Scrape content from an external documentation site or OpenAPI specification using the `mint scrape` commands. This is useful when you migrate your documentation from another platform to Mintlify. From 28d46b932fe2395350125588ee30eb9bc45362ef Mon Sep 17 00:00:00 2001 From: Kyle Finken Date: Wed, 25 Mar 2026 14:09:29 -0700 Subject: [PATCH 2/2] Cleanup docs title --- deploy/export.mdx | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/deploy/export.mdx b/deploy/export.mdx index f4dae599d..d075b9b2c 100644 --- a/deploy/export.mdx +++ b/deploy/export.mdx @@ -23,7 +23,9 @@ mint export The CLI builds your site, crawls every page defined in your navigation, and packages the output into a zip file in your current directory. -{/* TODO: Confirm exact output filename and whether it's configurable */} + + The export only includes pages listed in your navigation. [Hidden pages](/organize/hidden-pages) are not included in the archive. + ## What's in the zip @@ -42,13 +44,19 @@ The exported archive contains everything needed to view your docs offline: 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. + 1. Unzip the archive. 2. Double-click **Start Docs.command**. 3. The docs open in your default browser at `http://localhost:3000`. - macOS Gatekeeper may block the file because it was downloaded from the internet. To allow it, right-click (or Control-click) **Start Docs.command** and select **Open**, then select **Open** again in the confirmation dialog. You only need to do this once per file. + macOS may block the file because it was downloaded from the internet. If you see a security warning, go to **System Settings > Privacy & Security** and select **Open Anyway**. See [Apple's guide to overriding security settings](https://support.apple.com/guide/mac-help/mh40617/mac) for details. @@ -57,16 +65,7 @@ Share the zip file with anyone who has Node.js installed. To view the docs: 3. The docs open in your default browser at `http://localhost:3000`. - Windows SmartScreen may block the file because it was downloaded from the internet. You can unblock it in one of two ways: - - - **From the SmartScreen prompt**: Select **More info**, then select **Run anyway**. - - **From file properties**: Right-click **Start Docs.bat**, select **Properties**, check the **Unblock** checkbox in the Security section, then select **Apply**. + Windows may show a "Windows protected your PC" warning because the file was downloaded from the internet. Select **More info**, then select **Run anyway**. - - 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. -