diff --git a/installation.mdx b/installation.mdx index abf0159c6..208cc9970 100644 --- a/installation.mdx +++ b/installation.mdx @@ -228,6 +228,60 @@ Use flags to configure the validation command. - `--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: + + + + Double-click **Start Docs.command** or run: + + ```bash + node serve.js + ``` + + + Double-click **Start Docs.bat** or run: + + ```bash + node serve.js + ``` + + + ```bash + node serve.js + ``` + + + +The docs are served at `http://localhost:3000` by default. Set the `PORT` environment variable to use a different port. + + + 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 OpenAPI spec Check your OpenAPI file for errors with the following command: