llms.txt

Optimisez votre documentation pour permettre aux LLM de la lire et de l’indexer.

Le fichier llms.txt est une norme du secteur qui aide les LLM à indexer le contenu plus efficacement, comme un sitemap le fait pour les moteurs de recherche. Les outils d’IA peuvent utiliser ce fichier pour comprendre la structure de votre documentation et trouver le contenu pertinent pour les requêtes des utilisateurs.

Mintlify héberge automatiquement, à la racine de votre projet, un fichier llms.txt qui répertorie toutes les pages disponibles de votre documentation. Ce fichier est toujours à jour et ne nécessite aucun entretien. Vous pouvez également ajouter un fichier llms.txt personnalisé à la racine de votre projet.

Si votre site nécessite une authentification pour accéder à votre documentation, vos fichiers llms.txt et llms-full.txt ne sont pas accessibles aux LLM et aux outils d’IA. Les LLM et les outils d’IA ne peuvent indexer que le contenu accessible publiquement.

Affichez votre llms.txt en ajoutant /llms.txt à l’URL de votre site de documentation.

Ouvrir le llms.txt de ce site.

​

Structure de llms.txt

Un fichier llms.txt est un simple fichier Markdown qui contient :

• Le titre du site en tant que H1.
• Des sections de contenu structurées avec des liens et une description de chaque page de votre documentation.
• Des liens vers les spécifications d’API pointant vers vos spécifications OpenAPI et AsyncAPI, si votre documentation en inclut.

Le fichier llms.txt répertorie vos pages par ordre alphabétique selon leur emplacement dans votre référentiel, en commençant au répertoire racine.

La description de chaque page provient du champ description de son frontmatter. Pour les pages de référence d’API, la description inclut également les informations de spécification issues du champ de frontmatter openapi ou api. Les pages sans champ description apparaissent dans le fichier llms.txt sans description.

Example llms.txt

# Titre du site

## Documentation

- [API](https://example.com/docs/api) : Liste des endpoints et utilisation
- [Installation](https://example.com/docs/install) : Étapes de configuration
- [Prise en main](https://example.com/docs/start) : Guide d'introduction

## Spécifications API

- [openapi](https://example.com/docs/openapi.json)
- [asyncapi](https://example.com/docs/asyncapi.yaml)

Cette approche structurée permet aux LLMs de traiter efficacement votre documentation à un niveau global et de repérer le contenu pertinent pour les requêtes des utilisateurs, améliorant ainsi la précision et la rapidité des recherches documentaires assistées par l’IA.

​

llms-full.txt

Le fichier llms-full.txt regroupe l’intégralité de votre site de documentation en un seul fichier servant de contexte pour les outils d’IA et l’indexation par les LLM.

Mintlify héberge automatiquement un fichier llms-full.txt à la racine de votre projet. Affichez votre llms-full.txt en ajoutant /llms-full.txt à l’URL de votre site de documentation.

Ouvrir le llms-full.txt de ce site

​

Fichiers personnalisés

Pour ajouter un fichier llms.txt ou llms-full.txt personnalisé, créez un fichier llms.txt ou llms-full.txt à la racine de votre projet. L’ajout d’un fichier personnalisé remplace le fichier généré automatiquement portant le même nom. Si vous supprimez un fichier personnalisé, Mintlify restaure le fichier généré automatiquement.

Votre fichier llms.txt ou llms-full.txt personnalisé doit comporter le titre du site en tant que niveau de titre H1. Le reste du contenu est facultatif. Consultez Format dans la spécification llms.txt pour plus d’informations sur les sections facultatives et les bonnes pratiques.