Skip to main content
L’exportation statique nécessite un forfait Enterprise.
Utilisez l’API d’exportation statique pour pré-rendre votre site par programmation en un ensemble autonome de fichiers statiques et télécharger le résultat sous forme d’un unique bundle. Le bundle exporté est composé de HTML, CSS et JavaScript purs, sans dépendances d’exécution, afin que vous puissiez l’héberger sur n’importe quel stockage de fichiers statiques ou CDN.

URL des pages exportées

Les bundles d’exportation statique utilisent des URL de pages explicites avec l’extension .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

Une exportation statique s’exécute sous forme de tâche asynchrone. Vous démarrez la tâche, interrogez son statut, puis générez un bundle téléchargeable une fois la tâche terminée.
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

Les fonctionnalités disponibles dépendent de la manière dont vous hébergez votre déploiement. Les déploiements en air-gapped n’ont aucun accès réseau sortant, donc toute fonctionnalité qui repose sur les services cloud de Mintlify est indisponible. Les fonctionnalités étiquetées Configurable ont une disponibilité différente selon la configuration de votre environnement.

Endpoints

Authentification

Authentifiez les requêtes avec votre clé d’API admin. Générez une clé d’API admin sur la page des clés d’API de votre tableau de bord. Les clés d’API admin commencent par le préfixe 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 auto-hébergé se déploie avec le chart Helm du dépôt 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.
Comme les liens présignés expirent, régénérez le bundle et relancez la mise à niveau chaque fois que vous publiez du nouveau contenu, ou automatisez la boucle avec GitHub Actions.

Automatiser avec une GitHub Action

Le workflow modèle suivant exécute la boucle complète d’exportation selon un calendrier ou à la demande. Il démarre une tâche, interroge jusqu’à la fin de l’exportation, génère un bundle et déploie la nouvelle bundleUrl dans le chart Helm.
.github/workflows/static-export.yml
Stockez votre clé d’API admin sous forme de secret de dépôt MINTLIFY_ADMIN_KEY, et configurez les identifiants du cluster (par exemple, avec azure/setup-helm et votre kubeconfig) avant l’étape de déploiement.