Ajoutez des images, intégrez des vidéos et incluez du contenu interactif via des iframes dans votre documentation.
Toutes les ressources statiques de votre dépôt de documentation sont automatiquement servies au chemin approprié sur votre domaine. Par exemple, si vous avez /images/my-logo.png
dans votre dépôt, l’image sera disponible à l’adresse https://docs.yoursite.com/images/my-logo.png
.
Ajoutez des images pour apporter du contexte visuel, illustrer par des exemples ou agrémenter votre documentation.
Utilisez la syntaxe Markdown pour ajouter des images à votre documentation :

Incluez toujours un texte alternatif descriptif pour améliorer l’accessibilité et le référencement (SEO). Ce texte doit décrire clairement le contenu de l’image.
Les fichiers image doivent peser moins de 20 Mo. Pour les fichiers plus volumineux, hébergez-les sur un service CDN comme Amazon S3 ou Cloudinary .
Intégrations d’images en HTML
Pour un contrôle plus fin de l’affichage des images, utilisez des balises <img>
en HTML :
< img
src = "/images/dashboard.png"
alt = "Main dashboard interface"
height = "300"
className = "rounded-lg"
/>
Désactiver la fonctionnalité de zoom
Pour désactiver le zoom par défaut au clic sur les images, ajoutez la propriété noZoom
:
< img
src = "/images/screenshot.png"
alt = "Descriptive alt text"
noZoom
height = "200"
/>
Pour rendre une image cliquable, entourez l’image d’une balise de lien et ajoutez la propriété noZoom
:
< a href = "https://mintlify.com" target = "_blank" >
< img
src = "/images/logo.png"
alt = "Logo Mintlify"
noZoom
height = "100"
/>
</ a >
Les images à l’intérieur des balises de lien affichent automatiquement un curseur en forme de main pour indiquer qu’elles sont cliquables.
Images pour les modes clair et sombre
Pour afficher des images différentes selon les thèmes clair et sombre, utilisez les classes Tailwind CSS :
<!-- Image en mode clair -->
< img
className = "block dark:hidden"
src = "/images/light-mode.png"
alt = "Interface en mode clair"
/>
<!-- Image en mode sombre -->
< img
className = "hidden dark:block"
src = "/images/dark-mode.png"
alt = "Interface en mode sombre"
/>
Mintlify prend en charge les balises HTML dans Markdown , ce qui vous offre la flexibilité nécessaire pour créer du contenu riche.
Incluez toujours un texte de secours à l’intérieur des éléments vidéo pour les navigateurs qui ne prennent pas en charge la lecture vidéo.
Intégrez des vidéos YouTube à l’aide d’éléments iframe :
< iframe
className = "w-full aspect-video rounded-xl"
src = "https://www.youtube.com/embed/4KzFe50RQkQ"
title = "Lecteur vidéo YouTube"
frameBorder = "0"
allow = "accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
></ iframe >
Utilisez l’élément HTML <video>
pour du contenu vidéo auto-hébergé :
< video
controls
className = "w-full aspect-video rounded-xl"
src = "link-to-your-video.com"
></ video >
Lecture automatique de vidéos
Pour lancer automatiquement une vidéo, utilisez :
< video
autoPlay
muted
loop
playsInline
className = "w-full aspect-video rounded-xl"
src = "/videos/demo.mp4"
></ video >
Avec la syntaxe JSX, écrivez les attributs à deux mots en camelCase : autoPlay
, playsInline
, allowFullScreen
.
Intégrez du contenu externe à l’aide d’éléments iframe :
< iframe
src = "https://example.com/embed"
title = "Contenu intégré"
className = "w-full h-96 rounded-xl"
></ iframe >
Référence du composant Frame Découvrez comment utiliser le composant Frame pour présenter des images.