CmdocsCmdocs
Components

Images

Zoomable images with click-to-expand functionality.

Images

All images in your documentation are automatically zoomable — click any image to view it at full size. No extra syntax needed.

Basic Image

Use standard Markdown image syntax. Place your images in the public/ directory and reference them with an absolute path:

![Architecture diagram](/images/architecture.png)

cmdocs Open Graph

Images are automatically wrapped in a zoom component, so users can click to expand.

HTML Images

You can also use HTML <img> tags for more control over sizing:

<img src="/images/screenshot.png" alt="Dashboard screenshot" width="600" />
cmdocs Open Graph

The zoom behavior works with both Markdown ![]() syntax and <img> tags.

Image Best Practices

Use the public/ directory

Place all images in public/ and reference them with absolute paths like /images/photo.png

Add alt text

Always include descriptive alt text for accessibility and SEO.

Optimize file size

Use SVG for diagrams, PNG for screenshots, and WebP/JPEG for photos.

File Structure

docs.json
index.mdx
architecture.png
screenshot.png
light.svg
dark.svg

How is this guide?

On this page