Skip to content

Add docs for mint export#4774

Merged
k-finken merged 2 commits intomainfrom
Kyle/mint-export
Mar 25, 2026
Merged

Add docs for mint export#4774
k-finken merged 2 commits intomainfrom
Kyle/mint-export

Conversation

@k-finken
Copy link
Contributor

@k-finken k-finken commented Mar 20, 2026

Documentation changes

Add docs for new mint export feature

For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Low risk documentation-only change adding a new page and navigation links; no runtime or security-sensitive code is modified.

Overview
Adds new Offline export documentation describing how to run mint export, prerequisites, what the generated zip contains, and how recipients can launch the exported site on macOS/Windows/manual.

Updates the docs navigation (docs.json) to include deploy/export, and adds a new section to installation.mdx pointing users to the offline export docs.

Written by Cursor Bugbot for commit 28d46b9. This will update automatically on new commits. Configure here.

@mintlify
Copy link
Contributor

mintlify bot commented Mar 20, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Mar 20, 2026, 10:33 PM

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Copy link
Collaborator

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

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

just a few copy edits. Looks good to me!

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.
Copy link
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.


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.
Copy link
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
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)

Comment on lines +39 to +40
| `Start Docs.command` | macOS launcher — double-click to open the docs |
| `Start Docs.bat` | Windows launcher — double-click to open the docs |
Copy link
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 |

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

| `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
Copy link
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

@k-finken k-finken merged commit 45265b3 into main Mar 25, 2026
5 checks passed
@k-finken k-finken deleted the Kyle/mint-export branch March 25, 2026 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants