Encadrés
Une note ajoute du contexte supplémentaire.
Un encadré info met en avant des informations de contexte utiles.
Une validation confirme une réussite.
Un encadré danger signale quelque chose qui peut tout casser.
Cartes
Carte simple
Une carte avec une icône et du texte.
Carte avec lien
Ajoutez
href et toute la carte devient cliquable.Carte avec CTA
Ajoutez
cta pour personnaliser le libellé du lien.Carte horizontale
Utilisez
horizontal pour une mise en page compacte en pleine largeur.Colonnes
Colonne de gauche
Les colonnes organisent n’importe quel contenu dans une grille responsive.
Colonne de droite
Elles s’empilent sur les petits écrans.
Étapes
Première étape
Les étapes numérotent automatiquement une procédure.
2
Deuxième étape
Placez n’importe quel contenu dans une étape, y compris du code :
3
Troisième étape
Terminé.
Onglets
- Premier onglet
- Deuxième onglet
Les onglets permettent de basculer entre des alternatives, comme des systèmes d’exploitation ou des langages.
Groupes de code et blocs de code
highlight.py
Accordéons
Fermé par défaut
Fermé par défaut
Les accordéons masquent les détails jusqu’à ce que le lecteur souhaite les voir.
Ouvert par défaut
Ouvert par défaut
Définissez
defaultOpen pour qu’il soit déplié au départ.Diagrammes avec Mermaid
Écrivez un bloc délimitémermaid et Mintlify l’affiche, en mode clair comme en mode sombre.
Les organigrammes fonctionnent de la même manière.
Champs d’API
L’ID de l’utilisateur. Les paramètres de chemin, les paramètres de requête, les en-têtes et les champs du corps ont chacun leur propre variante.
Exemples de requête et de réponse
Cadres et images
Une image SVG dans un Frame, avec une légende.
Badges, infobulles et icônes
Stable Bêta Obsolète Contour Pilule Survolez pour afficher une infobulle. Icônes en ligne :Arborescence
merge-sort-api
main.py
requirements.txt
tests
docs
docs.json
index.mdx
openapi.json
Couleurs
primary
#0D9373
light
#55D799
surface
#F8FAFC
Carte de dépôt GitHub
mintlify/docs
Chargement des données du dépôt...
Prompt
Donnez ceci à votre agent de code pour qu'il rédige la documentation dans votre style.
Vues
Mathématiques
Des formules en ligne comme et des formules en bloc :Tableaux et Markdown
Les citations, le gras, l’italique, lebarré, lecode en ligneet les liens fonctionnent tous comme prévu.
- Les listes de tâches
- fonctionnent aussi