Export Markdown

Exportez des versions Markdown propres de vos pages de documentation pour les outils d’IA, les intégrations LLM et les workflows de traitement automatisé.

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.

​

Extension d’URL .md

Ajoutez .md à l’URL de n’importe quelle page pour afficher une version 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.

curl -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export

​

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.

<Visibility for="humans">
  Click the **Get started** button in the top-right corner to create your account.
</Visibility>

<Visibility for="agents">
  To create an account, call `POST /v1/accounts` with a valid email address.
</Visibility>

​

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 :

"markdown": {
  "schema": false
}

​

Retours des agents

Si vous activez les retours des agents, Mintlify ajoute un bloc <AgentInstructions> à l’export Markdown de chaque page indiquant aux agents comment soumettre des retours sur le contenu de la page.

Les agents soumettent des retours en envoyant une requête au endpoint avec le chemin de la page et le texte du retour.

Utilisez les retours des agents pour améliorer vos pages en fonction de ce que les agents trouvent incorrect, obsolète ou confus.

​

Raccourci clavier

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