-
Notifications
You must be signed in to change notification settings - Fork 225
Add docs for mint export #4774
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs for mint export #4774
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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. | ||||||||||
|
|
||||||||||
| 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. | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ## Prerequisites | ||||||||||
|
|
||||||||||
| - The [CLI](/installation) installed and up to date | ||||||||||
| - [Node.js](https://nodejs.org) v20.17.0+ installed | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ## 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 | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| 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 | | ||||||||||
|
Comment on lines
+39
to
+40
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ## View the exported docs | ||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
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> | ||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.