Image & Video

The Image & Video widgets bring multimedia into your documentation (screenshots, diagrams, walkthroughs, and embedded videos), so you can show, not just tell.

Image

To add an image:

1. Place your cursor where you want the image.
2. Type /image to open the widget menu.
3. Upload a file directly or insert it via URL.

Add alt text and a caption (recommended)

After adding an image, hover over it and select Alt text or Caption from the toolbar:

• Alt text: a short, descriptive explanation of the image content.
• Caption: optional text shown with the image to give readers context.

Why alt text matters

• Accessibility: screen readers describe the image for users of assistive technologies.
• SEO: search engines better understand the image's content and context.

Tips for good alt text: describe what's essential, keep it concise, and avoid "image of…" or "picture of…", the context usually implies it.

When to use a caption

Use a caption to add context (e.g. "Architecture diagram for the v2 flow"), reference a figure in the text, or clarify what readers should notice.

Golden-hour light briefly ignites the mountain face above a calm, glassy lake.

Video

To add a video:

1. Place your cursor where you want the video.
2. Type /video to open the widget menu.
3. Paste the video URL. The editor supports major hosts such as YouTube and Vimeo.