Layout
Image
::image places an image in a column, a card or a grid cell. For a full-height image, use the
image-left, image-right or image layouts.
Live demo
Syntax
Markdown
Markdown (image layout)
MDX
Attributes and props
| Attribute | Type | Default | Description |
|---|---|---|---|
src | string | — | Image path or URL |
alt | string | — | Required for accessibility |
fit | cover | contain | cover | How the image fills its box |
caption | ReactNode (MDX) | — | Text shown under the image |
Local images are copied into the build, or embedded in the single-file HTML export.
In other formats
| Format | Status | Notes |
|---|---|---|
deck | Available | Rendered in slides, the presenter console and the HTML and PDF exports. |
docs | Available | Through <StoryEmbed slug="…" /> in any page of a site. |
motion | Available | Animated block in a film. |
report | Planned · P6 | Section of a paged report. |
toon | Planned · P7 | Panel of a vertical strip. |
book | Planned · P8 | Block of a printable chapter. |