diff --git a/docs.json b/docs.json index 917f65563..af1132fe7 100644 --- a/docs.json +++ b/docs.json @@ -535,6 +535,7 @@ "pages": [ "fr/deploy/deployments", "fr/deploy/preview-deployments", + "fr/deploy/export", { "group": "/docs en sous-chemin", "pages": [ @@ -906,6 +907,7 @@ "pages": [ "es/deploy/deployments", "es/deploy/preview-deployments", + "es/deploy/export", { "group": "Subruta /docs", "pages": [ @@ -1277,6 +1279,7 @@ "pages": [ "zh/deploy/deployments", "zh/deploy/preview-deployments", + "zh/deploy/export", { "group": "/docs 子路径", "pages": [ diff --git a/es/deploy/export.mdx b/es/deploy/export.mdx new file mode 100644 index 000000000..1afbfbb90 --- /dev/null +++ b/es/deploy/export.mdx @@ -0,0 +1,79 @@ +--- +title: "Exportación offline" +description: "Exporta tu sitio de documentación como un archivo zip autocontenido para visualización y distribución sin conexión." +keywords: ["exportar", "offline", "zip", "sitio estático", "distribución", "mint export"] +--- + +Usa `mint export` para empaquetar todo tu sitio de documentación en un archivo zip autocontenido. Los destinatarios pueden descomprimirlo y ver la documentación en su navegador sin conexión a internet, sin una cuenta de Mintlify ni herramientas de compilación — solo necesitan tener instalado [Node.js](https://nodejs.org). + +Esto es útil cuando necesitas distribuir documentación a usuarios que no pueden acceder a tu sitio en producción, como clientes on-premise, entornos aislados (air-gapped) o revisiones internas de cumplimiento. + +
+ ## Requisitos previos +
+ +- La [CLI](/es/installation) instalada y actualizada +- [Node.js](https://nodejs.org) v20.17.0+ instalado + +
+ ## Exportar tu sitio +
+ +Navega al directorio de documentación que contiene tu archivo `docs.json` y ejecuta: + +```bash +mint export +``` + +La CLI compila tu sitio, rastrea todas las páginas definidas en tu navegación y empaqueta el resultado en un archivo zip en tu directorio actual. + + + La exportación solo incluye las páginas listadas en tu navegación. Las [páginas ocultas](/es/organize/hidden-pages) no se incluyen en el archivo. + + +
+ ## Qué contiene el zip +
+ +El archivo exportado contiene todo lo necesario para ver tu documentación sin conexión: + +| Archivo | Propósito | +|---|---| +| Páginas HTML | Versión pre-renderizada de cada página de tu navegación | +| `_next/static/` | CSS, JavaScript y otros recursos estáticos empaquetados | +| `serve.js` | Servidor HTTP de Node.js sin dependencias que sirve el sitio | +| `Start Docs.command` | Lanzador para macOS — haz doble clic para abrir la documentación | +| `Start Docs.bat` | Lanzador para Windows — haz doble clic para abrir la documentación | + +
+ ## Ver la documentación exportada +
+ +Comparte el archivo zip con cualquier persona que tenga Node.js instalado. Para ver la documentación: + + + + 1. Descomprime el archivo. + 2. Abre una terminal en el directorio descomprimido. + 3. Ejecuta `node serve.js`. + 4. Abre `http://localhost:3000` en tu navegador. + + + 1. Descomprime el archivo. + 2. Haz doble clic en **Start Docs.command**. + 3. La documentación se abre en tu navegador predeterminado en `http://localhost:3000`. + + + macOS puede bloquear el archivo porque fue descargado de internet. Si ves una advertencia de seguridad, ve a **Configuración del Sistema > Privacidad y Seguridad** y selecciona **Abrir de todos modos**. Consulta la [guía de Apple para anular la configuración de seguridad](https://support.apple.com/guide/mac-help/mh40617/mac) para más detalles. + + + + 1. Descomprime el archivo. + 2. Haz doble clic en **Start Docs.bat**. + 3. La documentación se abre en tu navegador predeterminado en `http://localhost:3000`. + + + Windows puede mostrar una advertencia "Windows protegió tu PC" porque el archivo fue descargado de internet. Selecciona **Más información** y luego selecciona **Ejecutar de todos modos**. + + + diff --git a/es/installation.mdx b/es/installation.mdx index fa3658f71..6fd94f7c6 100644 --- a/es/installation.mdx +++ b/es/installation.mdx @@ -306,6 +306,18 @@ mint migrate-mdx Este comando convierte páginas individuales de endpoints en MDX en páginas autogeneradas definidas en tu `docs.json`, mueve el contenido de MDX a la extensión `x-mint` en tu especificación de OpenAPI y actualiza tu navegación. Consulta [Migración desde MDX](/es/guides/migrating-from-mdx) para obtener información detallada. +
+ ### Exportar para visualización offline +
+ +Exporta todo tu sitio de documentación como un archivo zip autocontenido para visualización y distribución sin conexión: + +```bash +mint export +``` + +Consulta [Exportación offline](/es/deploy/export) para más detalles sobre el uso y la distribución del archivo exportado. +
### Importar contenido
diff --git a/fr/deploy/export.mdx b/fr/deploy/export.mdx new file mode 100644 index 000000000..df176f012 --- /dev/null +++ b/fr/deploy/export.mdx @@ -0,0 +1,79 @@ +--- +title: "Exportation hors ligne" +description: "Exportez votre site de documentation sous forme d'archive zip autonome pour une consultation et une distribution hors ligne." +keywords: ["export", "hors ligne", "zip", "site statique", "distribution", "mint export"] +--- + +Utilisez `mint export` pour empaqueter l'intégralité de votre site de documentation dans une archive zip autonome. Les destinataires peuvent décompresser l'archive et consulter la documentation dans leur navigateur sans connexion internet, sans compte Mintlify ni outil de build — ils ont uniquement besoin de [Node.js](https://nodejs.org) installé. + +Cela est utile lorsque vous devez distribuer la documentation à des utilisateurs qui ne peuvent pas accéder à votre site en production, par exemple pour des clients on-premise, des environnements isolés (air-gapped) ou des audits de conformité internes. + +
+ ## Prérequis +
+ +- La [CLI](/fr/installation) installée et à jour +- [Node.js](https://nodejs.org) v20.17.0+ installé + +
+ ## Exporter votre site +
+ +Accédez à votre répertoire de documentation contenant votre fichier `docs.json` et exécutez : + +```bash +mint export +``` + +La CLI compile votre site, parcourt toutes les pages définies dans votre navigation et empaquète le résultat dans un fichier zip dans votre répertoire actuel. + + + L'exportation inclut uniquement les pages listées dans votre navigation. Les [pages masquées](/fr/organize/hidden-pages) ne sont pas incluses dans l'archive. + + +
+ ## Contenu du zip +
+ +L'archive exportée contient tout le nécessaire pour consulter votre documentation hors ligne : + +| Fichier | Fonction | +|---|---| +| Pages HTML | Version pré-rendue de chaque page de votre navigation | +| `_next/static/` | CSS, JavaScript et autres ressources statiques empaquetés | +| `serve.js` | Serveur HTTP Node.js sans dépendance qui sert le site | +| `Start Docs.command` | Lanceur macOS — double-cliquez pour ouvrir la documentation | +| `Start Docs.bat` | Lanceur Windows — double-cliquez pour ouvrir la documentation | + +
+ ## Consulter la documentation exportée +
+ +Partagez le fichier zip avec toute personne disposant de Node.js. Pour consulter la documentation : + + + + 1. Décompressez l'archive. + 2. Ouvrez un terminal dans le répertoire décompressé. + 3. Exécutez `node serve.js`. + 4. Ouvrez `http://localhost:3000` dans votre navigateur. + + + 1. Décompressez l'archive. + 2. Double-cliquez sur **Start Docs.command**. + 3. La documentation s'ouvre dans votre navigateur par défaut à l'adresse `http://localhost:3000`. + + + macOS peut bloquer le fichier parce qu'il a été téléchargé depuis internet. Si vous voyez un avertissement de sécurité, accédez à **Réglages du système > Confidentialité et sécurité** et sélectionnez **Ouvrir quand même**. Consultez le [guide Apple pour contourner les réglages de sécurité](https://support.apple.com/guide/mac-help/mh40617/mac) pour plus de détails. + + + + 1. Décompressez l'archive. + 2. Double-cliquez sur **Start Docs.bat**. + 3. La documentation s'ouvre dans votre navigateur par défaut à l'adresse `http://localhost:3000`. + + + Windows peut afficher un avertissement "Windows a protégé votre ordinateur" parce que le fichier a été téléchargé depuis internet. Sélectionnez **Informations complémentaires**, puis sélectionnez **Exécuter quand même**. + + + diff --git a/fr/installation.mdx b/fr/installation.mdx index 459a813af..1c428305e 100644 --- a/fr/installation.mdx +++ b/fr/installation.mdx @@ -306,6 +306,18 @@ mint migrate-mdx Cette commande convertit les pages MDX d’endpoint individuelles en pages générées automatiquement, telles que définies dans votre `docs.json`, déplace le contenu MDX vers l’extension `x-mint` de votre spécification OpenAPI, et met à jour votre navigation. Consultez [Migration depuis MDX](/fr/guides/migrating-from-mdx) pour plus de détails. +
+ ### Exporter pour une consultation hors ligne +
+ +Exportez l'intégralité de votre site de documentation sous forme d'archive zip autonome pour une consultation et une distribution hors ligne : + +```bash +mint export +``` + +Consultez [Exportation hors ligne](/fr/deploy/export) pour plus de détails sur l'utilisation et la distribution de l'archive exportée. +
### Importer du contenu
diff --git a/zh/deploy/export.mdx b/zh/deploy/export.mdx new file mode 100644 index 000000000..9d547e4f8 --- /dev/null +++ b/zh/deploy/export.mdx @@ -0,0 +1,79 @@ +--- +title: "离线导出" +description: "将你的文档站点导出为自包含的 zip 归档文件，用于离线查看和分发。" +keywords: ["导出", "离线", "zip", "静态站点", "分发", "mint export"] +--- + +使用 `mint export` 将整个文档站点打包成一个自包含的 zip 归档文件。收件人可以解压后在浏览器中查看文档，无需互联网连接、Mintlify 账户或任何构建工具——只需安装 [Node.js](https://nodejs.org) 即可。 + +当你需要向无法访问线上站点的用户分发文档时（例如本地部署客户、隔离网络环境或内部合规审查），这非常有用。 + +
+ ## 前提条件 +
+ +- 已安装并更新至最新版本的 [CLI](/zh/installation) +- 已安装 [Node.js](https://nodejs.org) v20.17.0+ + +
+ ## 导出你的站点 +
+ +进入包含 `docs.json` 文件的文档目录，然后运行： + +```bash +mint export +``` + +CLI 会构建你的站点，抓取导航中定义的所有页面，并将输出打包为当前目录下的 zip 文件。 + + + 导出仅包含导航中列出的页面。[隐藏页面](/zh/organize/hidden-pages) 不会包含在归档中。 + + +
+ ## zip 中的内容 +
+ +导出的归档包含离线查看文档所需的一切： + +| 文件 | 用途 | +|---|---| +| HTML 页面 | 导航中每个页面的预渲染版本 | +| `_next/static/` | 打包的 CSS、JavaScript 和其他静态资源 | +| `serve.js` | 零依赖的 Node.js HTTP 服务器，用于提供站点服务 | +| `Start Docs.command` | macOS 启动器——双击即可打开文档 | +| `Start Docs.bat` | Windows 启动器——双击即可打开文档 | + +
+ ## 查看导出的文档 +
+ +将 zip 文件分享给任何安装了 Node.js 的人。要查看文档： + + + + 1. 解压归档文件。 + 2. 在解压后的目录中打开终端。 + 3. 运行 `node serve.js`。 + 4. 在浏览器中打开 `http://localhost:3000`。 + + + 1. 解压归档文件。 + 2. 双击 **Start Docs.command**。 + 3. 文档会在默认浏览器中打开，地址为 `http://localhost:3000`。 + + + macOS 可能会因为文件是从互联网下载的而阻止运行。如果看到安全警告，请前往**系统设置 > 隐私与安全性**，然后选择**仍要打开**。详情请参阅 [Apple 的安全设置覆盖指南](https://support.apple.com/guide/mac-help/mh40617/mac)。 + + + + 1. 解压归档文件。 + 2. 双击 **Start Docs.bat**。 + 3. 文档会在默认浏览器中打开，地址为 `http://localhost:3000`。 + + + Windows 可能会显示"Windows 已保护你的电脑"警告，因为该文件是从互联网下载的。选择**更多信息**，然后选择**仍要运行**。 + + + diff --git a/zh/installation.mdx b/zh/installation.mdx index 289fcf5f7..c36603389 100644 --- a/zh/installation.mdx +++ b/zh/installation.mdx @@ -306,6 +306,18 @@ mint migrate-mdx 此命令会将单个 MDX 端点页面转换为在你的 `docs.json` 中定义的自动生成页面，将 MDX 内容移至 OpenAPI 规范中的 `x-mint` 扩展，并更新你的导航。详见 [从 MDX 迁移](/zh/guides/migrating-from-mdx) 获取详细信息。 +
+ ### 导出用于离线查看 +
+ +将整个文档站点导出为自包含的 zip 归档文件，用于离线查看和分发： + +```bash +mint export +``` + +详见[离线导出](/zh/deploy/export)，了解如何使用和分发导出的归档文件。 +
### 导入对象