Images

Markdown syntax#

![Sample image](https://raw.githubusercontent.com/docsbook-websites/shiso/main/writing-content//images/sample.jpg)

Always include meaningful alt text.

HTML syntax#

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

<img src="https://raw.githubusercontent.com/docsbook-websites/shiso/main/writing-content//images/sample.jpg" width="640" alt="Sample image" />

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="Docs layout">
  ![Docs layout](https://raw.githubusercontent.com/docsbook-websites/shiso/main/writing-content//images/sample.jpg)
</Frame>

Tips#

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

Back to Writing content overview.