Export Markdown

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.

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

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 -L -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export

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>

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
}

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 :

"markdown": {
  "instructions": "Always cite the API version. Prefer the TypeScript SDK in examples."
}

Ou un tableau de chaînes, que Mintlify assemble avec des sauts de ligne :

"markdown": {
  "instructions": [
    "Always cite the API version.",
    "Prefer the TypeScript SDK in examples."
  ]
}

Mintlify affiche vos instructions sous forme de bloc Agent Instructions dans la sortie Markdown :

> ## Agent Instructions
> Always cite the API version.
> Prefer the TypeScript SDK in examples.

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.

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

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