Image

Images with captions and a lightbox view.

Hollow Knight: Silksong.

Usage#

Put the image description in square brackets and its path or URL in parentheses. Click an image to open the lightbox; press Escape to close it.

Caption#

Add a quoted title after the path to show a caption below the image.

Dimensions#

Set width and height to reserve the image's aspect ratio while it loads. The image still fits the available width.

Optimization#

Local images use the adapter's image optimization when available. Set optimize=false to disable it, or true to request it for a remote image.

Reference#

srcRequired
string

Image path or HTTP(S) URL.

altDefault undefined
string

Text describing the image. Use an empty string only for a decorative image.

titleDefault undefined
string

Markdown image title, displayed as a visible caption when nonblank.

widthDefault undefined
number | string

Intrinsic width in pixels. Supply height too to reserve the aspect ratio.

heightDefault undefined
number | string

Intrinsic height in pixels. Supply width too to reserve the aspect ratio.

optimizeDefault undefined
boolean

Use adapter image optimization. When omitted, enabled for root-relative local sources and disabled for remote sources.