diff --git a/es/installation.mdx b/es/installation.mdx index fa3658f71..eafa75d72 100644 --- a/es/installation.mdx +++ b/es/installation.mdx @@ -250,6 +250,34 @@ Utiliza flags para configurar el comando de validación. * `--groups [groupname]`: Simula grupos de usuarios para la validación (útil al probar control de acceso basado en grupos) * `--disable-openapi`: Desactiva la generación del archivo OpenAPI durante la validación +
+ ### Exportar un sitio estático +
+ +Exporta tu documentación como un sitio estático autónomo para despliegue sin conexión o en entornos aislados: + +```bash +mint export +``` + +Este comando genera un archivo ZIP que contiene todo tu sitio de documentación como archivos HTML estáticos, junto con scripts auxiliares para servir el sitio localmente. El archivo exportado incluye un servidor estático basado en Node.js y scripts de inicio para macOS/Linux y Windows. + +Por defecto, el archivo de salida se llama `export.zip`. Usa la opción `--output` para especificar una ruta de salida personalizada: + +```bash +mint export --output docs.zip +``` + +| Opción | Descripción | +| --- | --- | +| `--output` | Ruta del archivo ZIP de salida. Por defecto: `export.zip`. | +| `--groups` | Simula grupos de usuarios para la exportación (útil al exportar contenido restringido por grupo). | +| `--disable-openapi` | Desactiva la generación de archivos OpenAPI durante la exportación. | + + + Se requiere conexión a Internet en la primera ejecución para descargar la aplicación cliente. Las ejecuciones posteriores usan el cliente almacenado en caché en `~/.mintlify/`. + +
### Verificar la especificación de OpenAPI
diff --git a/fr/installation.mdx b/fr/installation.mdx index 459a813af..96cc0c284 100644 --- a/fr/installation.mdx +++ b/fr/installation.mdx @@ -250,6 +250,34 @@ Utilisez des options pour configurer la commande de validation. * `--groups [groupname]` : Simuler des groupes d’utilisateurs pour la validation (utile lors de tests de contrôle d’accès basé sur les groupes) * `--disable-openapi` : Désactiver la génération du fichier OpenAPI pendant la validation +
+ ### Exporter un site statique +
+ +Exportez votre documentation sous forme de site statique autonome pour un déploiement hors ligne ou en environnement isolé : + +```bash +mint export +``` + +Cette commande génère une archive ZIP contenant l'intégralité de votre site de documentation sous forme de fichiers HTML statiques, accompagnée de scripts utilitaires pour servir le site en local. L'archive exportée inclut un serveur statique basé sur Node.js et des scripts de lancement pour macOS/Linux et Windows. + +Par défaut, le fichier de sortie est nommé `export.zip`. Utilisez l'option `--output` pour spécifier un chemin de sortie personnalisé : + +```bash +mint export --output docs.zip +``` + +| Option | Description | +| --- | --- | +| `--output` | Chemin du fichier ZIP de sortie. Par défaut : `export.zip`. | +| `--groups` | Simuler des groupes d'utilisateurs pour l'export (utile lors de l'export de contenu soumis à un contrôle d'accès par groupe). | +| `--disable-openapi` | Désactiver la génération de fichiers OpenAPI pendant l'export. | + + + Une connexion Internet est requise lors de la première exécution pour télécharger l'application cliente. Les exécutions suivantes utilisent le client mis en cache dans `~/.mintlify/`. + +
### Vérifier la spécification OpenAPI
diff --git a/installation.mdx b/installation.mdx index abf0159c6..9e20f3c03 100644 --- a/installation.mdx +++ b/installation.mdx @@ -228,6 +228,32 @@ 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 + +Export your documentation as a self-contained static site for air-gapped or offline deployment: + +```bash +mint export +``` + +This command generates a ZIP archive containing your entire documentation site as static HTML files, along with helper scripts to serve the site locally. The exported archive includes a Node.js-based static server and launcher scripts for macOS/Linux and Windows. + +By default, the output file is named `export.zip`. Use the `--output` flag to specify a custom output path: + +```bash +mint export --output docs.zip +``` + +| Flag | Description | +| --- | --- | +| `--output` | Output ZIP file path. Defaults to `export.zip`. | +| `--groups` | Mock user groups for the export (useful when exporting group-restricted content). | +| `--disable-openapi` | Disable OpenAPI file generation during the export. | + + + An internet connection is required on first run to download the client application. Subsequent runs use the cached client from `~/.mintlify/`. + + ### Check OpenAPI spec Check your OpenAPI file for errors with the following command: diff --git a/zh/installation.mdx b/zh/installation.mdx index 289fcf5f7..44a997d99 100644 --- a/zh/installation.mdx +++ b/zh/installation.mdx @@ -250,6 +250,34 @@ mint validate * `--groups [groupname]`:为验证模拟用户组 (在测试基于用户组的访问控制时很有用) * `--disable-openapi`:在验证过程中禁用 OpenAPI 文件生成 +
+ ### 导出静态站点 +
+ +将你的文档导出为独立的静态站点,用于离线或隔离环境部署: + +```bash +mint export +``` + +此命令会生成一个 ZIP 压缩包,其中包含整个文档站点的静态 HTML 文件,以及用于本地提供服务的辅助脚本。导出的压缩包包含一个基于 Node.js 的静态服务器和适用于 macOS/Linux 和 Windows 的启动脚本。 + +默认情况下,输出文件名为 `export.zip`。使用 `--output` 标志来指定自定义输出路径: + +```bash +mint export --output docs.zip +``` + +| 标志 | 说明 | +| --- | --- | +| `--output` | 输出 ZIP 文件路径。默认为 `export.zip`。 | +| `--groups` | 为导出模拟用户组(在导出受组限制的内容时很有用)。 | +| `--disable-openapi` | 在导出过程中禁用 OpenAPI 文件生成。 | + + + 首次运行时需要网络连接以下载客户端应用程序。后续运行将使用 `~/.mintlify/` 中缓存的客户端。 + +
### 检查 OpenAPI 规范