LLMs.txt

mdui met à disposition les fichiers llms.txt et llms-full.txt, conçus pour fournir aux grands modèles de langage (LLM) un contexte clair et directement exploitable. Ils aident les IA à répondre de manière plus fiable aux questions concernant mdui.

Utiliser llms.txt comme contexte pour une IA

Deux formats sont disponibles :

• llms.txt : https://www.mdui.org/fr/docs/2/llms.txt
• llms-full.txt : https://www.mdui.org/fr/docs/2/llms-full.txt

llms.txt est un index concis, particulièrement adapté aux modèles capables d'accéder au Web et de récupérer les pages Markdown nécessaires via les liens qu'il contient. Il peut également servir à obtenir un aperçu rapide du projet.

llms-full.txt contient le contexte complet, c'est-à-dire l'intégralité du contenu des pages référencées dans llms.txt. Il est destiné aux modèles sans accès réseau, ou lorsqu'il est nécessaire de fournir tout le contexte en une seule fois.

Version Markdown de la documentation

Chaque page de documentation dispose d'une version Markdown correspondante : il suffit d'ajouter .md à la fin de l'URL de la page (ou index.md pour la page d'accueil).

Par exemple :

https://www.mdui.org/fr/docs/2/components/button → https://www.mdui.org/fr/docs/2/components/button.md
https://www.mdui.org/fr/docs/2/ → https://www.mdui.org/fr/docs/2/index.md

Vous pouvez utiliser directement ce lien Markdown, ou le contenu en texte brut de la page, comme contexte pour obtenir des réponses plus précises et ciblées.

Utiliser ces fichiers avec ChatGPT, Claude et autres LLM

Selon que le modèle prend en charge la navigation web ou le téléchargement de fichiers, choisissez l'une des options suivantes ou combinez-les :

1. Copier-coller : Collez le contenu de llms-full.txt en tant qu'instruction système ou comme premier message.

   Exemple : "Voici la documentation de référence de mdui. Basez-vous exclusivement sur ce contexte pour répondre aux questions suivantes. En cas de contradiction, ce contexte fait foi :\n\n[Collez le contenu de llms-full.txt]".

2. Fichier joint : Téléchargez llms-full.txt (ou llms.txt) et précisez dans le premier message "utilisez la pièce jointe comme contexte principal".

   Exemple : "En vous basant sur la documentation mdui jointe, indiquez-moi le mode d'emploi et les pièges à éviter avec <mdui-button>.".

3. Lecture en ligne : Fournissez le lien vers llms.txt ou llms-full.txt dans la conversation.

   Exemple : "Veuillez lire et utiliser https://www.mdui.org/fr/docs/2/llms-full.txt comme contexte pour répondre à mes questions sur mdui.".

4. Lien direct vers une page : Pour discuter d'un composant ou d'une fonction particulière, donnez directement l'adresse Markdown de cette page.

   Exemple : "Veuillez lire https://www.mdui.org/fr/docs/2/components/button.md et me donner trois bonnes pratiques basées sur ce document.".

Astuce : Cliquez sur l'icône en haut à droite de la page pour copier facilement les liens ci-dessus, accéder à la version Markdown de la page actuelle, ou utiliser celle-ci ou llms-full.txt comme contexte dans ChatGPT.