mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
c1171a757b
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
63 lines
3.8 KiB
Plaintext
63 lines
3.8 KiB
Plaintext
---
|
||
title: "llms.txt"
|
||
description: "Optimisez votre documentation pour permettre aux LLM de la lire et de l’indexer."
|
||
keywords: ["llms.txt", "LLM indexing", "AEO", "GEO", "content discovery"]
|
||
---
|
||
|
||
import { PreviewButton } from "/snippets/previewbutton.jsx"
|
||
|
||
Le [fichier llms.txt](https://llmstxt.org) 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.
|
||
|
||
<Note>
|
||
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.
|
||
</Note>
|
||
|
||
Affichez votre `llms.txt` en ajoutant `/llms.txt` à l’URL de votre site de documentation.
|
||
|
||
<PreviewButton href="https://mintlify.com/docs/llms.txt">Ouvrir le llms.txt de ce site.</PreviewButton>
|
||
|
||
|
||
<div id="llmstxt-structure">
|
||
## Structure de llms.txt
|
||
</div>
|
||
|
||
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.
|
||
|
||
Les pages sont classées 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. Les pages sans champ `description` apparaissent dans le fichier `llms.txt` sans description.
|
||
|
||
```mdx 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
|
||
```
|
||
|
||
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.
|
||
|
||
<div id="llms-fulltxt">
|
||
## llms-full.txt
|
||
</div>
|
||
|
||
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 est indexé par le trafic des 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.
|
||
|
||
<PreviewButton href="https://mintlify.com/docs/llms-full.txt">Ouvrir le llms-full.txt de ce site</PreviewButton>
|
||
|
||
<div id="custom-files">
|
||
## Fichiers personnalisés
|
||
</div>
|
||
|
||
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é remplacera le fichier généré automatiquement portant le même nom. Si vous supprimez un fichier personnalisé, le fichier par défaut sera de nouveau utilisé.
|
||
|
||
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](https://llmstxt.org/#format) dans la spécification `llms.txt` pour plus d’informations sur les sections facultatives et les bonnes pratiques. |