La exportación estática está en beta privada y requiere un acuerdo empresarial. Contacta con sales@mintlify.com para más información.
URLs de página en paquetes estáticos
.html que coinciden con los archivos del paquete. Por ejemplo, /guides/getting-started se convierte en /guides/getting-started.html. Esto sucede de forma automática y no requiere configuración.
Las URLs canónicas y las del sitemap siguen sin extensión. CloudFront resuelve estas URLs automáticamente, pero otros hostings estáticos pueden requerir reglas de reescritura.
Cómo funciona la exportación estática
1
Iniciar un trabajo de exportación estática
Llama a Iniciar trabajo de exportación estática con tu ID de proyecto. La API pone el trabajo en cola y devuelve un
jobId.Una implementación solo puede tener un trabajo activo a la vez. Si ya hay un trabajo queued o running para la implementación, el endpoint devuelve 409. El endpoint está limitado a 10 inicios de trabajo por organización por hora.2
Consultar el trabajo y descargar el paquete
Consulta Obtener estado del trabajo de exportación estática con el
jobId hasta que status sea completed. La respuesta completada incluye bundleUrl, un enlace de S3 prefirmado con tiempo limitado al paquete, junto con sizeBytes y una marca de tiempo expiresAt.Descarga el paquete antes de expiresAt. Una vez que caduque, vuelve a llamar al endpoint de estado para obtener un bundleUrl nuevo. Los archivos de exportación subyacentes siguen siendo reutilizables. Solo el enlace tiene tiempo limitado.Compatibilidad de funciones por tipo de despliegue
Endpoints
- Iniciar trabajo de exportación estática: Pone en cola un trabajo de exportación estática para un proyecto.
- Obtener estado del trabajo de exportación estática: Consulta el estado del trabajo y, una vez completado, recupera un enlace prefirmado para descargar el paquete.
Autenticación
mint_ y son secretos del lado del servidor: no las expongas en código del lado del cliente.
Copia tu ID de proyecto desde la misma página y úsalo como el parámetro de ruta projectId.
Desplegar el paquete en tu Helm chart de Enterprise
mintlify/enterprise. Una vez que un trabajo de exportación estática se completa, apuntas el chart al bundleUrl y el despliegue lo sirve desde tu propia infraestructura.
1
Añade la referencia al paquete en tus values
Configura los campos de exportación estática en tu
values.yaml con el bundleUrl devuelto por Obtener estado del trabajo de exportación estática. El chart descarga el paquete al iniciarse y lo sirve como la versión activa.values.yaml
2
Despliega el chart
Aplica los values actualizados con
helm upgrade. El despliegue descarga el paquete, lo intercambia como el sitio en vivo y lo sirve desde tu clúster.Automatizar con una GitHub Action
bundleUrl en el Helm chart.
.github/workflows/static-export.yml
MINTLIFY_ADMIN_KEY y establece PROJECT_ID con el ID de tu proyecto. Antes de desplegar, configura las credenciales del clúster, por ejemplo con azure/setup-helm y tu archivo de configuración de Kubernetes (kubeconfig).