Passer au contenu principal
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 de pages pré-rendues. Les destinataires peuvent décompresser l’archive et consulter la documentation dans leur navigateur 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 ou des audits de conformité internes. Les exportations ne sont pas entièrement autonomes. Certaines ressources sont chargées depuis des hôtes externes à l’exécution, et les exportations doivent être servies depuis la racine d’un domaine. Les environnements isolés (air-gapped), ainsi que l’hébergement d’une exportation dans une autre application ou sous un sous-chemin, ne sont pas entièrement pris en charge. Consultez les limitations avant de déployer une exportation dans un environnement sans accès à internet.

​
Prérequis

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

​
Limitations

  • 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.
  • Les exportations hors ligne doivent être servies depuis la racine d’un domaine, par exemple http://localhost:3000/. Servir une exportation sous un sous-chemin, comme /docs, n’est pas pris en charge.
  • Certaines ressources sont chargées depuis des hôtes externes à l’exécution. Sans accès à internet, ou derrière une Content Security Policy qui bloque ces hôtes, elles ne se chargent pas.

​
Ressources chargées depuis des hôtes externes

​
Exporter votre site

Accédez à votre répertoire de documentation contenant votre fichier docs.json et exécutez :
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

Par exemple, pour exporter votre site avec un nom de fichier personnalisé et un groupe d’utilisateurs spécifique :
L’exportation inclut uniquement les pages listées dans votre navigation. Les pages masquées ne sont pas incluses dans l’archive.

​
Considérations de sécurité

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 --groups contrô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.

​
Contenu du zip

L’archive exportée contient vos pages pré-rendues, leurs ressources groupées et un serveur pour les consulter :

​
Consulter la documentation exportée

Partagez le fichier zip avec toute personne disposant de Node.js. Pour consulter la documentation :
  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.

Sujets connexes

Référence des commandes de la CLI MintlifyExport PDFMigrer la documentation vers Mintlify depuis un export ZIP