Images et intégrations

Ajoutez des images, intégrez des vidéos et insérez du contenu interactif via des iframes dans votre documentation.

Photographie d’un paysage pittoresque avec des fleurs violettes au premier plan, des montagnes à l’arrière-plan et un ciel bleu parsemé de nuages.

Images

Ajoutez des images pour fournir du contexte visuel, des exemples ou pour agrémenter votre documentation.

Syntaxe d’image de base

Utilisez la syntaxe Markdown pour ajouter des images à votre documentation :

![Texte alternatif décrivant l'image](/images/screenshot.png)

Les chemins d’image sont relatifs à la racine de votre dépôt de documentation. Par exemple, si votre image se trouve à images/screenshot.png dans votre dépôt, le chemin est /images/screenshot.png. Les chemins relatifs (par exemple, ./screenshot.png) ne sont pas pris en charge.

Incluez toujours un texte alternatif descriptif pour améliorer l’accessibilité et le SEO. Le texte alternatif doit décrire clairement ce que montre l’image.

Les fichiers image doivent faire 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 HTML

Pour un meilleur contrôle de l’affichage des images, utilisez des balises HTML <img> :

<img 
  src="/images/dashboard.png" 
  alt="Interface principale du tableau de bord"
  style={{height: "300px", width: "400px"}}
  className="rounded-lg"
/>

Redimensionner des images avec des styles en ligne

Utilisez des styles JSX en ligne avec l’attribut style pour redimensionner les images :

<img
  src="/images/architecture.png"
  style={{width: "450px", height: "auto"}}
  alt="Diagramme illustrant l'architecture du système"
/>

Désactiver le zoom des images

Pour désactiver le zoom par défaut au clic sur les images, ajoutez la propriété noZoom :

<img 
  src="/images/screenshot.png" 
  alt="Texte alternatif descriptif"
  noZoom
/>

Lier des images

Pour rendre une image cliquable, placez l’image dans une balise d’ancre et ajoutez la propriété noZoom :

<a href="https://mintlify.com" target="_blank">
  <img 
    src="/images/logo.png" 
    alt="Logo Mintlify"
    noZoom
  />
</a>

Les images à l’intérieur des balises d’ancrage affichent automatiquement un curseur en forme de pointeur pour indiquer qu’elles sont cliquables.

Images pour les modes clair et sombre

Pour afficher des images différentes en mode clair et en mode 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"
/>

Images SVG

Les fichiers SVG qui utilisent des éléments foreignObject s’affichent différemment en production qu’en développement local. Le CDN d’images de Mintlify supprime foreignObject des SVG à titre de mesure de sécurité, ce qui peut tronquer ou masquer du texte et d’autres contenus HTML intégrés. Cela affecte fréquemment les SVG exportés à partir d’outils comme draw.io lorsque le formatage de texte HTML ou le renvoi à la ligne est activé. Pour corriger cela, désactivez Formatted Text et Word Wrap sur tous les libellés de votre diagramme avant d’exporter en SVG. Consultez la documentation draw.io pour plus d’informations sur les exportations SVG.

Vidéos

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 remplacement à l’intérieur des éléments vidéo pour les navigateurs qui ne prennent pas en charge la lecture des vidéos.

Intégrations YouTube

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"
  allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
  allowFullScreen
></iframe>

Vidéos auto‑hébergées

Utilisez l’élément HTML <video> pour des vidéos auto‑hébergées :

<video
  controls
  className="w-full aspect-video rounded-xl"
  src="lien-vers-votre-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>

Lorsque vous utilisez la syntaxe JSX, écrivez les attributs composés de deux mots en camelCase : autoPlay, playsInline, allowFullScreen.

Iframes

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>

Encapsulez les iframes dans un composant frame pour les maintenir dans la largeur de la colonne de texte et éviter tout débordement.

<Frame>
  <iframe 
    src="https://example.com/embed" 
    title="Contenu intégré"
    className="w-full h-96 rounded-xl"
  ></iframe>
</Frame>

Référence du composant Frame

Découvrez comment utiliser le composant Frame pour présenter des images.

​Images

​Syntaxe d’image de base

​Intégrations d’images HTML

​Redimensionner des images avec des styles en ligne

​Désactiver le zoom des images

​Lier des images

​Images pour les modes clair et sombre

​Images SVG

​Vidéos

​Intégrations YouTube

​Vidéos auto‑hébergées

​Lecture automatique de vidéos

​Iframes

​Ressources connexes

Référence du composant Frame

Images

Syntaxe d’image de base

Intégrations d’images HTML

Redimensionner des images avec des styles en ligne

Désactiver le zoom des images

Lier des images

Images pour les modes clair et sombre

Images SVG

Vidéos

Intégrations YouTube

Vidéos auto‑hébergées

Lecture automatique de vidéos

Iframes

Ressources connexes