Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions deploy/export.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
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.

Check warning on line 7 in deploy/export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/export.mdx#L7

Don't put a space before or after a dash.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
Use the `mint export` command to package your entire documentation site into a self-contained zip archive. Share the zip archive with users who need offline access to your content. Anyone you send the archive to can unzip it and view your docs in their browser without an internet connection, a Mintlify account, or any build tools. They must have [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.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
Use offline exports 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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Node.js](https://nodejs.org) v20.17.0+ installed
- [Node.js](https://nodejs.org) v20.17.0+ installed (LTS versions recommended)


## 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.

<Note>
The export only includes pages listed in your navigation. [Hidden pages](/organize/hidden-pages) are not included in the archive.
</Note>

## What's in the zip
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## What's in the zip
### 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 |

Check warning on line 39 in deploy/export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/export.mdx#L39

Don't put a space before or after a dash.
| `Start Docs.bat` | Windows launcher — double-click to open the docs |

Check warning on line 40 in deploy/export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/export.mdx#L40

Don't put a space before or after a dash.
Comment on lines +39 to +40
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `Start Docs.command` | macOS launcherdouble-click to open the docs |
| `Start Docs.bat` | Windows launcherdouble-click to open the docs |
| `Start Docs.command` | macOS launcherdouble-click to open the docs |
| `Start Docs.bat` | Windows launcherdouble-click to open the docs |


## View the exported docs
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## View the exported docs
## View your exported docs

Just to mirror the earlier heading structure


Share the zip file with anyone who has Node.js installed. To view the docs:

<Tabs>
<Tab title="Manual">
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.
</Tab>
<Tab title="macOS">
1. Unzip the archive.
2. Double-click **Start Docs.command**.
3. The docs open in your default browser at `http://localhost:3000`.

<Note>
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.
</Note>
</Tab>
<Tab title="Windows">
1. Unzip the archive.
2. Double-click **Start Docs.bat**.
3. The docs open in your default browser at `http://localhost:3000`.

<Note>
Windows may show a "Windows protected your PC" warning because the file was downloaded from the internet. Select **More info**, then select **Run anyway**.
</Note>
</Tab>
</Tabs>
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@
"pages": [
"deploy/deployments",
"deploy/preview-deployments",
"deploy/export",
{
"group": "/docs subpath",
"root": "deploy/docs-subpath",
Expand Down
10 changes: 10 additions & 0 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@
```

<Note>
Only HTTPS URLs are supported in production deployments. The `--local-schema` flag is for local development only.

Check warning on line 248 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L248

In general, use active voice instead of passive voice ('are supported').
</Note>

### Create a workflow
Expand Down Expand Up @@ -276,6 +276,16 @@

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.
Expand Down
Loading