L’exportation statique est en bêta privée et nécessite un accord entreprise. Contactez sales@mintlify.com pour en savoir plus.
URL des pages dans les bundles statiques
.html qui correspondent aux fichiers du bundle. Par exemple, /guides/getting-started devient /guides/getting-started.html. Cela se produit automatiquement et ne nécessite aucune configuration.
Les URL canoniques et celles du sitemap restent sans extension. CloudFront résout ces URL automatiquement, mais d’autres hébergeurs statiques peuvent nécessiter des règles de réécriture.
Fonctionnement de l’exportation statique
1
Démarrer une tâche d'exportation statique
Appelez Démarrer une tâche d’exportation statique avec l’identifiant de votre projet. L’API met la tâche en file d’attente et renvoie un
jobId.Un déploiement ne peut avoir qu’une seule tâche active à la fois. Si une tâche est déjà queued ou running pour le déploiement, l’endpoint retourne 409. L’endpoint est limité à 10 démarrages de tâche par organisation et par heure.2
Interroger la tâche et télécharger le bundle
Interrogez Obtenir le statut d’une tâche d’exportation statique avec le
jobId jusqu’à ce que status soit completed. La réponse d’une tâche terminée inclut bundleUrl, un lien S3 présigné limité dans le temps vers le bundle, ainsi que sizeBytes et un horodatage expiresAt.Téléchargez le bundle avant expiresAt. Une fois le lien expiré, rappelez l’endpoint de statut pour obtenir une nouvelle bundleUrl. Les fichiers d’exportation sous-jacents 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 : mettre en file d’attente une tâche d’exportation statique pour un projet.
- Obtenir le statut d’une tâche d’exportation statique : interroger l’état de la tâche et, une fois terminée, récupérer un lien présigné de téléchargement du bundle.
Authentification
mint_ et sont des secrets côté serveur — ne les exposez pas dans du code côté client.
Copiez l’identifiant de votre projet depuis la même page et utilisez-le comme paramètre de chemin projectId.
Déployer le bundle sur votre chart Helm Enterprise
mintlify/enterprise. Une fois qu’une tâche d’exportation statique est terminée, vous pointez le chart vers la bundleUrl 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 Obtenir le statut d’une tâche d’exportation statique. 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 définissez PROJECT_ID sur l’identifiant de votre projet. Avant le déploiement, configurez les identifiants du cluster, par exemple avec azure/setup-helm et votre fichier de configuration Kubernetes (kubeconfig).