Images

Put image assets under public/ and reference them with absolute site paths.

Markdown syntax#

![Sample image](/images/sample.jpg)

Always include meaningful alt text.

Images have extra vertical spacing and open at full size when clicked. The zoom dialog can also be opened with the keyboard and closed with Escape.

HTML syntax#

Use an <img> tag when you need explicit dimensions or other attributes:

<img src="/images/sample.jpg" width="640" alt="Sample image" />

Add noZoom when an image should not open in the full-size viewer:

<img src="/images/sample.jpg" alt="Sample image" noZoom />

Images wrapped in links automatically disable zoom so clicking them follows the link instead.

Where assets live#

Paths are served as-is from the static build output — no image pipeline or optimization step runs at build time.

Framed screenshots#

Wrap media in Frame when you want a border and caption:

<Frame caption="The default docs layout">
  ![Docs layout](/images/sample.jpg)
</Frame>

Tips#

• keep screenshots reasonably sized for docs readability
• prefer SVG for logos and simple diagrams
• set width/height on large images when layout shift matters