Las exportaciones offline requieren un plan Enterprise.
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.
Las exportaciones no son totalmente autocontenidas. Algunos recursos se cargan desde hosts externos en tiempo de ejecución, y las exportaciones deben servirse desde la raíz de un dominio. Los entornos aislados (air-gapped) y el alojamiento de una exportación dentro de otra aplicación o bajo una subruta no son totalmente compatibles. Revisa las limitaciones antes de desplegar una exportación en un entorno sin acceso a internet.
Requisitos previos
Limitaciones
- Las exportaciones offline no admiten búsqueda. Para añadir búsqueda offline, indexa el HTML exportado con una herramienta de búsqueda estática.
- Las exportaciones offline no admiten el asistente de Mintlify.
- Las exportaciones offline deben servirse desde la raíz de un dominio, como
http://localhost:3000/. No se admite servir una exportación bajo una subruta, como/docs. - Algunos recursos se cargan desde hosts externos en tiempo de ejecución. Sin acceso a internet, o detrás de una Content Security Policy que bloquee estos hosts, no se cargan.
Recursos que se cargan desde hosts externos
Exportar tu sitio
docs.json y ejecuta:
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.
Consideraciones de seguridad
- El flag
--groupscontrola 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
Ver la documentación exportada
- Manual
- macOS
- Windows
- Descomprime el archivo.
- Abre una terminal en el directorio descomprimido.
- Ejecuta
node serve.js. - Abre
http://localhost:3000en tu navegador.