Passer au contenu principal
Le fichier install.md fournit des instructions d’installation orientées tâches pour des agents IA comme Claude Code, Cursor et ChatGPT. Contrairement à la documentation traditionnelle rédigée pour des lecteurs humains, install.md présente les étapes d’installation sous forme de commandes directes que ces agents exécutent de manière autonome. Mintlify génère automatiquement un fichier install.md à la racine de votre projet en agrégeant et en synthétisant les pages de documentation liées à l’installation. Ce fichier est toujours à jour et ne nécessite aucune maintenance. Affichez votre install.md en ajoutant /install.md à l’URL de votre site de documentation. Ouvrir le fichier install.md de ce site.

​
Fonctionnement de install.md

Mintlify identifie automatiquement les pages de votre documentation qui contiennent du contenu lié à l’installation en recherchant des mots-clés dans les chemins et les titres de page. Les pages masquées et les pages exclues de l’indexation sont automatiquement filtrées.
  • installation ou install
  • quickstart ou quick-start
  • getting-started ou getting_started
  • setup ou set-up
  • introduction ou intro
  • overview
Mintlify synthétise ces pages dans un format concis, orienté vers les tâches et optimisé pour l’exécution par des agents IA.
  1. Extrait toutes les commandes shell, les URL et les instructions spécifiques à une plateforme.
  2. Réorganise le contenu en un objectif clair avec des critères de réussite.
  3. Présente les étapes sous forme de commandes directes plutôt que de documentation passive.
  4. Inclut une liste de tâches TODO pour que les agents puissent suivre la progression.
  5. Supprime les sections de dépannage et les fonctionnalités optionnelles pour se concentrer sur le parcours d’installation principal.
Mintlify ne génère pas de fichier install.md lorsque :
  • Votre documentation est privée ou nécessite une authentification.
  • Vous avez un fichier install.md personnalisé à la racine de votre projet.
  • Aucune page liée à l’installation n’est trouvée dans votre documentation.

​
Structure de install.md

Un fichier install.md est un fichier Markdown simple qui contient :
  • Ouverture conversationnelle : Présente le contenu comme une demande de l’utilisateur destinée à déclencher une exécution autonome.
  • Énoncé de l’objectif : Formulation claire de ce qui doit être installé.
  • Condition de réussite : Résultat mesurable précis qui prouve la réussite de l’installation.
  • Liste de tâches TODO : Tâches générales.
  • Instructions détaillées : Commandes étape par étape avec toutes les commandes shell nécessaires.
  • Directive d’exécution : Instruction de clôture qui déclenche une action immédiate.

​
install.md personnalisé

Pour ajouter un fichier install.md personnalisé, créez un fichier install.md à la racine de votre projet. L’ajout d’un fichier personnalisé remplace le fichier généré automatiquement. Si vous supprimez le fichier personnalisé, Mintlify génère un nouveau fichier install.md. Votre fichier install.md personnalisé doit suivre un format axé sur les tâches, avec une introduction conversationnelle, un objectif clair, des critères de réussite et une liste de tâches TODO pour maximiser l’efficacité avec les agents d’IA.
Envoyez un email à [email protected] pour désactiver install.md.