Skip to main content

​
Image

Images are the most common way to add visual content to your documentation.

​
Basics

The markdown syntax lets you add images using the following code
To make sure images are displayed correctly in production, add a forward slash to the image path (e.g. /path/image.jpg).
Note that the image file size must be less than 20MB. Otherwise, we recommend hosting on a CDN provider like S3, Cloudinary or a similar service.

​
Embeds

To get more customizability with images, you can also use embeds to add images.

​
Disable Image Zoom

To disable the default zoom on click for images, add the noZoom property to image embeds.

​
Linking Images

To link an image, for example to create a button on your docs, encompass the image in a link with the noZoom property. Images in a tags will automatically have a pointer cursor.

​
Dark Mode

To use separate images for light and dark mode, use Tailwind CSS to hide and show images.
For more information, we recommend the following sections:

Frame Component Reference

Read the reference for the Frame component

​
Videos


Mintlify supports HTML tags in Markdown. This is helpful if you prefer HTML tags to Markdown syntax, and lets you create documentation with infinite flexibility.
For YouTube videos use:
For other videos, use:
To autoplay the video, use:
Since Mintlify needs to adhere to the JSX syntax, double word attributes will need to be written in camelCase such as autoPlay and playsInline.

​
iFrames

Loads another HTML page within the document.