Image Block

Display images in your documentation using standard markdown syntax.

Syntax

![Alt text](path/to/image.png)

Relative path:

![My Image](../../assets/my-image.png)

Absolute URL:

![External Image](https://example.com/image.png)

Parameters

• Alt text: Descriptive text for accessibility (required)
• Path: Relative path to assets folder or absolute URL
• Formats: PNG, JPG, GIF, WebP, SVG
• Preferred Size: 580 x 350 px for optimal display

File size limits

• SVG: keep under 40 KB.
• PNG / JPG / GIF / WebP: keep under 20 MB.

Files larger than the suggested size will fail to deploy and render via EDS' image pipeline.

Example