L’exportation statique nécessite un forfait Enterprise.
URL des pages exportées
.html. Ainsi, /guides/getting-started devient /guides/getting-started.html, et la page d’accueil devient /index.html.
Cette structure correspond aux fichiers du bundle. Elle permet un hébergement S3 ou statique simple, sans nécessiter la réécriture d’URL sans extension. Conservez les noms de fichiers .html lors du téléversement. L’API d’exportation statique active automatiquement ce format, vous n’avez donc pas besoin de modifier la configuration de votre documentation.
Les déploiements avec CloudFront préservent la navigation côté client et le préchargement des pages. Les hébergeurs de fichiers simples prennent en charge la navigation par pages complètes grâce aux liens .html générés. Les sites de production hébergés normalement dans le cloud restent inchangés.
La navigation interne intégrée utilise également des destinations en .html. Cela concerne notamment les sélecteurs de version et de langue, les résultats de recherche, les cartes, les citations de l’assistant et les liens du playground d’API. Les chaînes de requête sont conservées. Les liens du playground d’API continuent donc de fonctionner.
Les URL canoniques et celles du sitemap restent sans extension. Vos URL personnalisées de navigation côté client peuvent également rester sans extension. Les déploiements reposant sur CloudFront les résolvent, mais les hébergeurs qui servent uniquement des fichiers peuvent nécessiter des réécritures.
Fonctionnement de l’exportation statique
1
Démarrer une tâche d'exportation statique
Appelez Démarrer une tâche d’exportation statique avec le domaine que vous souhaitez exporter. L’API met la tâche en file d’attente et renvoie un
jobId.2
Interroger le statut de la tâche
Interrogez Obtenir le statut d’une tâche d’exportation statique avec le
jobId jusqu’à ce que status soit completed. La réponse inclut progress et pageCount en direct pendant l’exécution de la tâche.3
Générer le bundle
Appelez Générer le bundle d’exportation avec le
jobId. L’API empaquète l’exportation dans une seule archive et renvoie bundleUrl, un lien S3 présigné vers le bundle d’exportation statique, ainsi qu’un horodatage expiresAt. Téléchargez le bundle avant expiresAt — passé ce délai, rappelez Générer le bundle d’exportation pour obtenir un nouveau lien. La tâche sous-jacente et ses fichiers restent réutilisables ; seul le lien est limité dans le temps.Prise en charge des fonctionnalités par type de déploiement
Endpoints
- Démarrer une tâche d’exportation statique : démarrer une tâche d’exportation statique pour un déploiement.
- Obtenir le statut d’une tâche d’exportation statique : interroger le statut et la progression d’une tâche en cours.
- Générer le bundle d’exportation : empaqueter une tâche terminée et renvoyer un unique lien S3 vers le bundle.
Authentification
mint_ et sont des secrets côté serveur — ne les exposez pas dans du code côté client.
Déployer le bundle sur votre chart Helm Enterprise
mintlify/enterprise. Une fois qu’une tâche d’exportation statique produit un bundle, vous pointez le chart vers le bundle et le déploiement le sert depuis votre propre infrastructure.
1
Ajouter la référence du bundle à vos valeurs
Définissez les champs d’exportation statique dans votre
values.yaml sur la bundleUrl renvoyée par Générer le bundle d’exportation. Le chart récupère le bundle au démarrage et le sert comme version active.values.yaml
2
Déployer le chart
Appliquez les valeurs mises à jour avec
helm upgrade. Le déploiement télécharge le bundle, le remplace en tant que site en direct et le sert depuis votre cluster.Automatiser avec une GitHub Action
bundleUrl dans le chart Helm.
.github/workflows/static-export.yml
MINTLIFY_ADMIN_KEY, et configurez les identifiants du cluster (par exemple, avec azure/setup-helm et votre kubeconfig) avant l’étape de déploiement.