Exportation hors ligne
Exportez votre site de documentation sous forme d'archive zip autonome pour la consultation hors ligne, la distribution interne ou un environnement isolé.
Les exportations hors ligne nécessitent une offre Enterprise.
Utilisez mint export pour empaqueter l’intégralité de votre site de documentation dans une archive zip autonome. Les destinataires peuvent décompresser l’archive et consulter la documentation dans leur navigateur sans connexion internet, sans compte Mintlify ni outil de build—ils ont uniquement besoin de Node.js installé.
Cela est utile lorsque vous devez distribuer la documentation à des utilisateurs qui ne peuvent pas accéder à votre site en production, par exemple pour des clients on-premise, des environnements isolés (air-gapped) ou des audits de conformité internes.
- Les exportations hors ligne ne prennent pas en charge la recherche. Pour ajouter la recherche hors ligne, indexez le code HTML exporté avec un outil de recherche statique.
- Les exportations hors ligne ne prennent pas en charge l’assistant Mintlify.
Accédez à votre répertoire de documentation contenant votre fichier docs.json et exécutez :
mint exportLa CLI compile votre site, parcourt toutes les pages définies dans votre navigation et empaquète le résultat dans un fichier zip dans votre répertoire actuel.
| Flag | Description | Par défaut |
|---|---|---|
--output <path> | Définit le chemin du fichier zip de sortie. | export.zip |
--groups <group> | Simule des groupes d’utilisateurs pour l’exportation. Utile lorsque votre documentation utilise un contrôle d’accès basé sur les groupes et que vous souhaitez que l’archive inclue les pages restreintes. | — |
--disable-openapi | Ignore la génération des fichiers OpenAPI pendant l’exportation. Utilisez cette option si vous avez de nombreuses spécifications OpenAPI et souhaitez des builds plus rapides. | — |
Par exemple, pour exporter votre site avec un nom de fichier personnalisé et un groupe d’utilisateurs spécifique :
mint export --output customer-docs.zip --groups enterpriseL’exportation inclut uniquement les pages listées dans votre navigation. Les pages masquées ne sont pas incluses dans l’archive.
L’archive exportée est un bundle statique et non authentifié. Toute personne disposant du fichier zip peut consulter chaque page qu’il contient.
- L’option
--groupscontrôle quelles pages à accès restreint par groupe Mintlify inclut dans l’archive au moment de l’exportation. Elle n’applique pas d’authentification après l’exportation. - Ne partagez les archives qu’avec des destinataires autorisés à voir le contenu qu’elles contiennent.
- Régénérez et redistribuez l’archive pour publier de nouvelles modifications — les destinataires qui utilisent un zip plus ancien continueront à voir l’ancien contenu.
L’archive exportée contient tout le nécessaire pour consulter votre documentation hors ligne :
| Fichier | Fonction |
|---|---|
| Pages HTML | Version pré-rendue de chaque page de votre navigation |
_next/static/ | CSS, JavaScript et autres ressources statiques empaquetés |
serve.js | Serveur HTTP Node.js sans dépendance qui sert le site |
Start Docs.command | Lanceur macOS—double-cliquez pour ouvrir la documentation |
Start Docs.bat | Lanceur Windows—double-cliquez pour ouvrir la documentation |
Partagez le fichier zip avec toute personne disposant de Node.js. Pour consulter la documentation :
- Décompressez l’archive.
- Ouvrez un terminal dans le répertoire décompressé.
- Exécutez
node serve.js. - Ouvrez
http://localhost:3000dans votre navigateur.
- Décompressez l’archive.
- Double-cliquez sur Start Docs.command.
- La documentation s’ouvre dans votre navigateur par défaut à l’adresse
http://localhost:3000.
macOS peut bloquer le fichier parce qu’il a été téléchargé depuis internet. Si vous voyez un avertissement de sécurité, accédez à Réglages du système > Confidentialité et sécurité et sélectionnez Ouvrir quand même. Consultez le guide Apple pour contourner les réglages de sécurité pour plus de détails.
- Décompressez l’archive.
- Double-cliquez sur Start Docs.bat.
- La documentation s’ouvre dans votre navigateur par défaut à l’adresse
http://localhost:3000.
Windows peut afficher un avertissement “Windows a protégé votre ordinateur” parce que le fichier a été téléchargé depuis internet. Sélectionnez Informations complémentaires, puis sélectionnez Exécuter quand même.