
Mintlify supports files up to 5 MB. To use larger files, consider a storage
service like Cloudinary and embed in your Mintlify documentation.
Image
Using Markdown
The markdown syntax lets you add images using the following codeUsing 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 thenoZoom
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.Related
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.
Since Mintlify needs to adhere to the JSX syntax, double word attributes will need to
be written in camelCase: autoPlay, playsInline.
iFrames
Loads another HTML page within the document.Although not required, we recommend adding the
alt
and title
attributes to
images for better SEO and accessability. Learn more at image
SEO.