Skip to content
Closed
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
54 changes: 54 additions & 0 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,60 @@
- `--groups [groupname]`: Mock user groups for validation (useful when testing group-based access control)
- `--disable-openapi`: Disable OpenAPI file generation during validation

### Export a static site

Generate a self-contained static site as a zip archive for air-gapped or offline deployment:

```bash
mint export
```

This command builds your documentation, renders every page, and bundles the output with all static assets into a zip file. The archive includes a lightweight Node.js server and launcher scripts for macOS and Windows so anyone can view the docs locally without an internet connection.

By default, the output file is `export.zip`. Use the `--output` flag to specify a custom filename:

```bash
mint export --output docs.zip
```

| Flag | Description |
| --- | --- |
| `--output` | Set the output zip file path. Defaults to `export.zip`. |
| `--groups` | Mock user groups for the export. |
| `--disable-openapi` | Disable OpenAPI file generation during export. |

#### View the exported site

After exporting, unzip the archive and open the docs:

<Tabs>
<Tab title="macOS">
Double-click **Start Docs.command** or run:

```bash
node serve.js
```
</Tab>
<Tab title="Windows">
Double-click **Start Docs.bat** or run:

```bash
node serve.js
```
</Tab>
<Tab title="Linux">
```bash
node serve.js
```
</Tab>
</Tabs>

The docs are served at `http://localhost:3000` by default. Set the `PORT` environment variable to use a different port.

Check warning on line 279 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L279

In general, use active voice instead of passive voice ('are served').

<Note>
Node.js is required on the machine where you view the exported docs. The first time you run `mint export`, an internet connection is needed to download the client. Subsequent exports can run offline.

Check warning on line 282 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L282

In general, use active voice instead of passive voice ('is required').

Check warning on line 282 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L282

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

### Check OpenAPI spec

Check your OpenAPI file for errors with the following command:
Expand All @@ -245,7 +299,7 @@
```

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

Check warning on line 302 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L302

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

### Create a workflow
Expand Down
Loading