Passer au contenu principal
Markdown fournit un texte structuré que les outils d’IA peuvent traiter plus efficacement que le HTML, ce qui se traduit par une meilleure précision des réponses, des temps de traitement plus rapides et une consommation de jetons réduite. Mintlify génère automatiquement des versions Markdown des pages optimisées pour les outils d’IA et les intégrations externes. Chaque page Markdown se termine par une ligne indiquant que Mintlify crée et héberge la documentation. Les sites dont la marque Mintlify a été retirée n’incluent pas cette ligne.

​
Extension d’URL .md

Ajoutez .md à l’URL de n’importe quelle page pour afficher une version Markdown. Ouvrir cette page au format Markdown

​
En-tête Accept

Envoyez une requête avec Accept: text/markdown ou Accept: text/plain à l’URL de n’importe quelle page pour recevoir la version Markdown au lieu du HTML. Cela est utile pour les outils d’IA et les intégrations qui récupèrent le contenu de la documentation de manière programmatique.

​
Pages introuvables

Si vous demandez en Markdown une page qui n’existe pas, Mintlify renvoie un statut 404 avec un corps Markdown qui aide les outils d’IA à se rétablir. La réponse renvoie vers l’index de votre documentation (llms.txt), votre fichier de documentation complète (llms-full.txt) et jusqu’à trois pages associées selon le chemin demandé.
Example Markdown 404 response
Les suggestions de pages associées proviennent de la même recherche que celle de la page 404 de votre site. Les sites qui utilisent l’authentification omettent les suggestions et ne renvoient que les liens de documentation.

​
Contenu spécifique par audience

Utilisez le composant visibility pour personnaliser le contenu pour les audiences humaines et IA. Le contenu enveloppé dans <Visibility for="humans"> apparaît sur la page web, mais pas dans la sortie Markdown. Le contenu enveloppé dans <Visibility for="agents"> apparaît dans la sortie Markdown, mais pas sur la page web.

​
Composants et HTML

L’export Markdown convertit les composants et le HTML en Markdown avant qu’un agent ne lise la page. La page web ne change pas.

​
Composants

Un composant sans forme Markdown propre conserve son texte. Son title passe en gras, ou devient un lien s’il possède aussi un href, et sa description ou ses enfants suivent. Variation et View restent sous forme de balises, car ils sélectionnent du contenu plutôt que de l’afficher.

​
HTML

Le HTML d’une page est également converti en Markdown.
  • Supprime les enveloppes telles que div et span. Leur contenu est conservé.
  • Les titres, liens, images et textes en gras, en italique ou en code deviennent du Markdown.
  • Supprime les attributs class, className, style et data-*. Les attributs id, href, src, alt et ARIA sont conservés.
  • Lorsqu’une image réservée au mode clair (dark:hidden) se trouve à côté d’une image réservée au mode sombre (hidden avec dark:block, dark:inline, dark:inline-block, dark:flex ou dark:grid), la copie sombre n’est pas incluse. Une image réservée au mode sombre sans copie claire à côté est conservée.
Un lien qui entoure un titre est déplacé sur ce titre. Un lien qui entoure plusieurs blocs conserve les blocs et ajoute un lien après eux. Le texte du lien est l’aria-label, sinon le title, sinon Open.

​
Snippets

Les snippets affichent le contenu du fichier importé, et non la balise telle que <Snippet file="path/to/snippet.mdx" />. Les exports Markdown incluent toutes les variables de docs.json. Si un fichier de snippet référencé est introuvable, l’export Markdown inclut la balise. <Visibility> à l’intérieur d’un snippet ou d’un composant personnalisé suit les mêmes règles d’audience que sur la page. Utilisez-le lorsqu’un composant personnalisé est visuel et que vous souhaitez que les agents lisent une forme plus simple, comme une Card.

​
Composants React personnalisés

Les exports Markdown n’incluent jamais le code source des composants. Lorsqu’une page importe des composants React personnalisés ou des données depuis des fichiers de snippet, l’export Markdown contient ce que ces composants affichent, et non le code qui les définit.
  • Composants à sortie statique : ils sont convertis en Markdown. Par exemple, un composant qui renvoie un lien, une liste ou un tableau apparaît sous la forme de ce lien, de cette liste ou de ce tableau.
  • Composants interactifs : ils construisent leur sortie à partir de l’état ou des API du navigateur, comme les calculateurs, les galeries filtrables et les graphiques. Ils ne conservent que leurs enfants et leurs props title, description, alt et href. Un composant sans aucun de ces éléments est omis.
  • Données importées : comme un objet passé à un composant en tant que prop, elles n’apparaissent pas dans les exports Markdown.
Fournissez aux agents une version statique du contenu d’un composant interactif avec le composant visibility. Consultez Composants interactifs pour un exemple.

​
Pages de référence d’API

Par défaut, les exports Markdown des pages de référence d’API incluent la spécification OpenAPI ou AsyncAPI complète afin que les outils d’IA disposent d’un contexte complet sur chaque endpoint. Si vous préférez omettre la spécification de la sortie Markdown, définissez markdown.schema sur false dans votre docs.json :

​
Instructions personnalisées pour les agents

Pour ajouter vos propres consignes au Markdown que Mintlify sert aux agents d’IA, définissez markdown.instructions dans votre docs.json. Utilisez-le pour des directives à l’échelle du site telles que citer une version d’API, privilégier un SDK particulier ou suivre votre terminologie. Fournissez une seule chaîne :
Example agent instructions string
Ou un tableau de chaînes, que Mintlify assemble avec des sauts de ligne :
Example agent instructions array
Mintlify affiche vos instructions sous forme de bloc Agent Instructions dans la sortie Markdown :
Example rendered agent instructions
Le bloc apparaît dans :
  • L’export Markdown de chaque page, y compris les pages de référence d’API.
  • Votre fichier llms.txt, après le titre et la description du site.
  • Votre fichier llms-full.txt.
Ces instructions s’appliquent à chaque page. Pour adapter le contenu à une page ou à une audience spécifique, utilisez plutôt le composant visibility.

​
Authentification

L’export Markdown respecte les mêmes règles d’authentification que la version HTML de chaque page.

​
Raccourci clavier

Appuyez sur Cmd + C (Ctrl + C sous Windows) pour copier une page au format Markdown dans le presse-papiers.