Jamdesk Documentation logo

Cadre

Enveloppez les images et les démos dans un conteneur bordé et stylisé avec des légendes optionnelles. Fait ressortir les captures d'écran.

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

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

Utilisez Frame lorsque vous souhaitez :

  • Donner une apparence soignée aux captures d'écran et aux images d'interface
  • Ajouter des légendes pour expliquer ce que les lecteurs voient
  • Distinguer la sortie de démo du contenu ordinaire
  • 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 frame :

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 n'importe quel contenu, pas seulement les images :

✓ Build completed successfully
✓ 42 pages generated
✓ Deployed to production
Exemple de sortie de code

Quand NE PAS utiliser Frame

  • Images décoratives en ligne - Les images Markdown ordinaires 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 le lecteur voit
  • Utilisez de manière cohérente - Si vous encadrez une capture d'écran, encadrez toutes les captures d'écran pour une cohérence visuelle
  • N'encadrez pas trop - Réservez les frames aux visuels importants, pas à chaque image de la page

Props

string

Texte optionnel sous le frame.

Et ensuite ?

Vue d'ensemble des composants

Parcourir tous les composants disponibles

Bases MDX

Apprendre à utiliser les composants dans MDX