Image & Video

The Image & Video widgets in Theneo's web editor allow you to seamlessly integrate multimedia elements into your API documentation.

Image

To add an image:

1. Place your cursor in the editor where you want the image to appear.
2. Type /image to activate the widget menu.
3. Choose to upload your image file directly or insert it via URL.

Add Alt text and a Caption (recommended)

After adding an image:

1. Hover over the image in the editor.
2. In the image toolbar, select Alt text or Caption.
3. Enter your text:

• Alt text: Add a short, descriptive explanation of the image content.
• Caption: Add optional text displayed with the image to provide context for readers.

Why Alt text matters

Alt text improves:

• Accessibility: Screen readers can describe the image for users who rely on assistive technologies.
• SEO: Search engines can better understand the image content and context.

Tips for good Alt text

• Describe what’s essential: what the image shows and why it matters.
• Keep it clear and concise.
• Avoid “image of…” or “picture of…” unless necessary - the context usually implies it.

When to use a Caption

Captions are helpful when you want to:

• Add context or explanation (e.g., “Architecture diagram for v2 flow”)
• Reference a figure in the text (e.g., “See Figure 1”)
• Clarify what the reader should notice

Video

To add a video:

1. Place your cursor in the editor where you want the video to appear.
2. Type /video to activate the widget menu.
3. Paste the URL of the video you wish to embed. The editor typically supports video content from major hosting platforms such as YouTube and Vimeo.