Exportation hors ligne

Exportez votre site de documentation sous forme d’archive zip autonome pour une consultation et une distribution hors ligne.

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.

​

Prérequis

• La CLI installée et à jour
• Node.js v20.17.0+ installé

​

Exporter votre site

Accédez à votre répertoire de documentation contenant votre fichier docs.json et exécutez :

mint export

La 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.

​

Options

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 enterprise

L’exportation inclut uniquement les pages listées dans votre navigation. Les pages masquées ne sont pas incluses dans l’archive.

​

Contenu du zip

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

​

Consulter la documentation exportée

Partagez le fichier zip avec toute personne disposant de Node.js. Pour consulter la documentation :

Manuel

1. Décompressez l’archive.
2. Ouvrez un terminal dans le répertoire décompressé.
3. Exécutez node serve.js.
4. Ouvrez http://localhost:3000 dans votre navigateur.

macOS

1. Décompressez l’archive.
2. Double-cliquez sur Start Docs.command.
3. 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.

Windows

1. Décompressez l’archive.
2. Double-cliquez sur Start Docs.bat.
3. 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.