Images & Videos

Enhance your documentation with images and video embeds.

Static Assets

Place images and videos in docs/public/. During build, these files are copied to the root of your site.

Reference them with root-relative paths:

![Logo](/images/logo.png)
::video[/videos/demo.mp4]

Images

Basic Image

With Caption

Add a caption using the caption attribute:

With Dimensions

Control image size with width and height:

Disable Lightbox

Prevent the image from opening in a lightbox:

YouTube

Embed YouTube videos with privacy-friendly mode (no cookies):

With Start Time

Start the video at a specific time:

Vimeo

Embed Vimeo videos with Do Not Track enabled:

Native Video

You can also host your own video files. Place them in docs/public/ and reference them using the syntax shown below.

Syntax

Images:

![Alt text](/path/to/image.png)

![Alt text](/image.png){caption="Figure caption"}

![Alt text](/image.png){width="600" height="400"}

![Alt text](/image.png){nozoom}

![Alt text](/image.png){caption="Caption" width="600" nozoom}

YouTube:

::youtube[VIDEO_ID]

::youtube[VIDEO_ID]{start="30"}

::youtube[VIDEO_ID]{autoplay muted loop}

Vimeo:

::vimeo[VIDEO_ID]

::vimeo[VIDEO_ID]{autoplay muted}

Native Video:

::video[/path/to/video.mp4]{controls}

::video[/path/to/video.mp4]{controls autoplay muted loop}

::video[/path/to/video.mp4]{controls poster="/poster.jpg" preload="metadata"}

Reference

Image Attributes

Video Attributes

Privacy

• YouTube: Uses youtube-nocookie.com (no tracking cookies)
• Vimeo: Uses dnt=1 parameter (Do Not Track)

Image credit: Photo by Christopher Becke on Pexels. Video credits: BBC Earth on YouTube, Yosemite Winter Wonders by Rudy Wilms on Vimeo.