Jamdesk Documentation logo

Frame

Frame umschließt Bilder und Demos in einem Rahmen mit optionalen Bildunterschriften und sorgt so für ein einheitliches, professionelles Erscheinungsbild Ihrer Dokumentationsvisuals.

Frame umschließt Bilder und Demos in einem Rahmen mit optionalen Bildunterschriften.

Verwenden Sie Frame, wenn Sie:

  • Screenshots und UI-Bildern ein fertiges Aussehen geben möchten
  • Bildunterschriften hinzufügen möchten, die erklären, was Leser sehen
  • Demo-Ausgaben vom regulären Inhalt abheben möchten
  • Visuals in Ihrer Dokumentation einheitlich gestalten möchten

Verwendung

<Frame caption="Architecture diagram">

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

</Frame>

Einfacher Frame

City skyline

<Frame>

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

</Frame>

Mit Bildunterschrift

Fügen Sie eine Bildunterschrift unterhalb des Frames hinzu:

City skyline

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

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

</Frame>

Andere Inhalte einrahmen

Frame akzeptiert beliebige Inhalte, nicht nur Bilder:

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

Wann Sie Frame NICHT verwenden sollten

  • Dekorative Bilder im Fließtext: Reguläre Markdown-Bilder eignen sich gut für Illustrationen
  • Icons oder kleine Grafiken: Frame fügt unnötiges visuelles Gewicht hinzu
  • Bilder, die mit dem Text fließen: Frame erzeugt einen visuellen Bruch. Verwenden Sie ihn für eigenständige Visuals

Best Practices

  • Bildunterschriften kurz halten: ein Satz, der erklärt, was der Leser sieht
  • Konsistent verwenden: Wenn Sie einen Screenshot umrahmen, umrahmen Sie jeden Screenshot
  • Nicht übermäßig umrahmen: Reservieren Sie Frames für wichtige Visuals, nicht für jedes Bild auf der Seite

Props

string

Optionaler Text unterhalb des Frames.

Wie geht es weiter?

Komponenten-Übersicht

Alle verfügbaren Komponenten durchsuchen

MDX-Grundlagen

Erfahren Sie, wie Sie Komponenten in MDX verwenden

Die Screenshots zeigen die Benutzeroberfläche auf Englisch.