Frame

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

Die Screenshots zeigen die Benutzeroberfläche auf Englisch.

Verwenden Sie Frame, wenn Sie:

• Screenshots und UI-Bildern ein fertiges Erscheinungsbild geben möchten
• Bildunterschriften hinzufügen möchten, um zu erklären, was Leser sehen
• Demoausgaben von regulären Inhalten unterscheiden möchten
• Eine visuelle Einheitlichkeit in Ihrer Dokumentation schaffen möchten

Verwendung

<Frame caption="Architecture diagram">

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

</Frame>

Einfacher Frame

<Frame>

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

</Frame>

Mit Bildunterschrift

Fügen Sie unterhalb des Frames eine Bildunterschrift hinzu:

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

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

</Frame>

Andere Inhalte einrahmen

Frame funktioniert mit beliebigen Inhalten, nicht nur mit Bildern:

✓ Build completed successfully
✓ 42 pages generated
✓ Deployed to production

Wann Sie Frame NICHT verwenden sollten

• Inline-Dekorationsbilder – Reguläre Markdown-Bilder eignen sich gut für Illustrationen
• Icons oder kleine Grafiken – Frame erzeugt ein unnötig starkes visuelles Gewicht
• Bilder, die in den Text eingebettet sind – Frame erzeugt eine visuelle Trennung; verwenden Sie es für eigenständige Visualisierungen

Best Practices

• Halten Sie Bildunterschriften kurz – Ein Satz, der erklärt, was der Leser sieht
• Verwenden Sie Frame konsistent – Wenn Sie einen Screenshot einrahmen, rahmen Sie aus Gründen der visuellen Einheitlichkeit alle Screenshots ein
• Rahmen Sie nicht alles ein – Reservieren Sie Frames für wichtige Visualisierungen, nicht für jedes Bild auf der Seite

Props

Wie geht es weiter?