Jamdesk Documentation logo

Frame

Frame place images et démos dans un conteneur bordé avec légendes optionnelles, pour une cohérence visuelle de la documentation.

Frame place les images et les démos dans un conteneur bordé avec légendes optionnelles.

Les captures d'écran montrent l'interface en anglais.

Utilisez Frame lorsque vous voulez :

  • Donner aux captures d'écran et images d'interface un aspect soigné
  • Ajouter des légendes pour expliquer ce que les lecteurs voient
  • Distinguer le résultat d'une démo du contenu habituel
  • Créer une cohérence visuelle dans votre documentation

Utilisation

<Frame caption="Architecture diagram">

  ![Diagram](/images/city-skyline.jpg)

</Frame>

Frame basique

City skyline

<Frame>

  ![City skyline](/images/city-skyline.webp)

</Frame>

Avec légende

Ajoutez une légende sous le cadre :

City skyline

New York City at dusk
<Frame caption="New York City at dusk">

  ![City skyline](/images/city-skyline.webp)

</Frame>

Encadrer d'autres contenus

Frame fonctionne avec tout type de contenu, pas seulement des images :

✓ Build completed successfully
✓ 42 pages generated
✓ Deployed to production
Example code output

Quand NE PAS utiliser Frame

  • Images décoratives en ligne - Les images markdown classiques conviennent pour les illustrations
  • Icônes ou petits graphiques - Frame ajoute un poids visuel inutile
  • Images qui s'intègrent au texte - Frame crée une rupture visuelle ; à réserver aux visuels autonomes

Bonnes pratiques

  • Gardez les légendes concises - Une phrase qui explique ce que voit le lecteur
  • Utilisez de façon cohérente - Si vous encadrez une capture d'écran, encadrez toutes les captures d'écran pour une cohérence visuelle
  • N'abusez pas des cadres - Réservez les cadres aux visuels importants, pas à chaque image de la page

Props

string

Texte optionnel sous le cadre.

Et ensuite ?

Vue d'ensemble des composants

Parcourir tous les composants disponibles

Bases de MDX

Apprendre à utiliser les composants dans MDX