Jamdesk Documentation logo

Riquadro

Frame racchiude immagini e demo in un contenitore bordato con didascalie opzionali, per mantenere uniformi gli elementi visivi della documentazione.

Frame racchiude immagini e demo in un contenitore bordato con didascalie opzionali.

Gli screenshot mostrano l'interfaccia in inglese.

Usa Frame per:

  • Dare a screenshot e immagini dell'interfaccia un aspetto rifinito
  • Aggiungere didascalie per spiegare ciò che vedono i lettori
  • Distinguere l'output delle demo dal contenuto normale
  • Creare uniformità visiva nella documentazione

Utilizzo

<Frame caption="Architecture diagram">

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

</Frame>

Frame di base

Panorama urbano

<Frame>

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

</Frame>

Con didascalia

Aggiungi una didascalia sotto il riquadro:

Panorama urbano

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

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

</Frame>

Riquadrare altri contenuti

Frame funziona con qualsiasi contenuto, non solo con le immagini:

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

Quando NON usare Frame

  • Immagini decorative inline - Le immagini Markdown normali sono adatte per le illustrazioni
  • Icone o elementi grafici piccoli - Frame aggiunge un peso visivo non necessario
  • Immagini integrate nel testo - Frame crea una separazione visiva; usalo per elementi visivi autonomi

Buone pratiche

  • Mantieni le didascalie concise - Una frase che spiega ciò che vede il lettore
  • Usalo in modo coerente - Se aggiungi un riquadro a uno screenshot, aggiungilo a tutti gli screenshot per garantire uniformità visiva
  • Non usare Frame eccessivamente - Riserva i riquadri agli elementi visivi importanti, non a ogni immagine della pagina

Proprietà

string

Testo opzionale sotto il riquadro.

Passaggi successivi

Components Overview

Browse all available components

MDX Basics

Learn how to use components in MDX