Saltar al contenido principal
Las exportaciones offline requieren un plan Enterprise.
Usa mint export para empaquetar todo tu sitio de documentación en un archivo zip de páginas prerrenderizadas. Los destinatarios pueden descomprimirlo y ver la documentación en su navegador sin una cuenta de Mintlify ni herramientas de compilación. Solo necesitan tener instalado Node.js. Esto es útil cuando necesitas distribuir documentación a usuarios que no pueden acceder a tu sitio en producción, como clientes on-premise o revisiones internas de cumplimiento. La CLI empaqueta en el archivo los iconos, las fuentes y los estilos de LaTeX que usa tu sitio, por lo que la documentación exportada funciona en entornos aislados (air-gapped) sin acceso a internet. Las exportaciones se sirven desde la raíz de un dominio, a menos que configures una ruta base. Revisa las limitaciones antes de desplegar una exportación.

​
Requisitos previos

  • La CLI instalada y actualizada
  • Node.js v20.17.0+ instalado

​
Limitaciones

  • Las exportaciones offline no admiten el asistente de Mintlify.
  • Las exportaciones offline no incluyen analytics ni otras integraciones configuradas en tu docs.json.
  • Las imágenes y otros archivos que tus páginas referencian mediante una URL externa no se empaquetan. Guárdalos en tu proyecto para incluirlos en el archivo.
La barra de búsqueda funciona en la documentación exportada sin conexión de red. Cuando ejecutas mint export, la CLI genera un índice de búsqueda a partir de las páginas exportadas y lo guarda en el archivo. El navegador busca en ese índice de forma local. La búsqueda offline sigue las mismas reglas que la búsqueda en tu sitio en vivo. Omite las páginas ocultas de la búsqueda, como las páginas con noindex: true o searchable: false en su frontmatter. Los resultados solo incluyen páginas en el idioma y la versión actuales del lector.

​
Recursos empaquetados

Cuando ejecutas mint export, la CLI descarga los recursos que tu sitio carga desde hosts externos y los guarda en el archivo. Esto incluye:
  • Iconos referenciados por nombre, como los iconos de Font Awesome y Lucide.
  • Iconos de lenguaje de los bloques de código y banderas del selector de idioma.
  • Google Fonts y fuentes alojadas externamente.
  • Hojas de estilo y fuentes de LaTeX.
  • Archivos referenciados desde las hojas de estilo empaquetadas.
El equipo que ejecuta mint export necesita acceso a internet para descargar estos recursos. La CLI solo descarga recursos de hosts públicos. Si un recurso no se descarga, la CLI muestra una advertencia could not bundle <url> y la documentación exportada carga ese recurso desde su host original.

​
Exportar tu sitio

Navega al directorio de documentación que contiene tu archivo docs.json y ejecuta:
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.

​
Opciones

Por ejemplo, para exportar tu sitio con un nombre de archivo personalizado y un grupo de usuarios específico:
La exportación solo incluye las páginas listadas en tu navegación. Las páginas ocultas no se incluyen en el archivo.

​
Servir bajo una subruta

De forma predeterminada, una exportación se sirve desde la raíz de un dominio, como http://localhost:3000/. Para servirla bajo una subruta, pasa la ruta con --base-path:
La CLI añade la ruta base como prefijo a los enlaces, las imágenes, los favicons y los recursos empaquetados, y serve.js sirve la documentación en http://localhost:3000/docs/. Una solicitud a la raíz redirige a la ruta base. La ruta base puede contener letras, números, guiones y guiones bajos, con segmentos separados por /, como /docs o /product/docs. La exportación falla si alguna ruta de página empieza por la ruta base. Por ejemplo, --base-path /docs falla si tu navegación incluye una página en docs/intro. Elige una ruta base que no use ninguna página.

​
Fijar la versión del cliente

De forma predeterminada, mint export compila tu sitio con la versión más reciente del cliente de Mintlify compatible con tu versión de la CLI. Para compilar con una versión específica, pasa su número de versión con --client-version:
La CLI descarga esa versión desde releases.mintlify.com antes de compilar la exportación. Fija una versión cuando necesites que las exportaciones repetidas se rendericen igual, por ejemplo, cuando regeneras un archivo para el mismo cliente. Si la descarga falla y la CLI ya tiene una versión del cliente en caché de una ejecución anterior, la CLI compila la exportación con la versión en caché.

​
Consideraciones de seguridad

El archivo exportado es un paquete estático y sin autenticación. Cualquier persona que tenga el archivo zip puede ver todas las páginas que contiene.
  • El flag --groups controla qué páginas restringidas por grupo incluye Mintlify en el archivo al momento de exportar. No aplica autenticación después de la exportación.
  • Comparte los archivos únicamente con destinatarios autorizados a ver el contenido que contienen.
  • Regenera y vuelve a distribuir el archivo para publicar nuevos cambios: los destinatarios que ejecuten un zip anterior seguirán viendo el contenido anterior.

​
Qué contiene el zip

El archivo exportado contiene tus páginas prerrenderizadas, sus recursos empaquetados y un servidor para verlas:

​
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.

​
Alojar la exportación en tu propio servidor

Para alojar una exportación en tu propio servidor web en lugar de usar serve.js, sirve la carpeta descomprimida como archivos estáticos desde la raíz de un dominio. Si exportaste con --base-path, sirve la carpeta bajo esa ruta y aplica estas reglas a la parte de la ruta de la solicitud posterior a la ruta base:
  1. Páginas: Sirve <path>/index.html para una solicitud a /<path>.
  2. Caché: Sirve _mintlify/assets/* y _mintlify/export-assets/* con Cache-Control: public, max-age=31536000, immutable. Sirve las páginas con Cache-Control: no-cache.
serve.js implementa ambas reglas, así que puedes usarlo como referencia. Si exportaste con la opción --classic, el archivo usa el diseño del cliente clásico y necesita reglas diferentes. El archivo README.md de ese archivo comprimido las enumera.