Skip to main content
在文档中添加图片、嵌入视频,并通过 iframes 引入交互式内容。
一张风景照片:前景为紫色花朵,远处是群山,天空湛蓝,点缀着零散白云。

图像

在文档中添加图像,以提供可视化的 context、示例或装饰。

基本图像语法

使用 Markdown 语法向文档中添加图像:
请务必包含具有描述性的 alt 文本,以提升可访问性和 SEO(搜索引擎优化)。alt 文本应清晰说明图像所呈现的内容。
图像文件必须小于 20 MB。对于更大的文件,请将其托管在 Amazon S3Cloudinary 等 CDN 服务上。

HTML 图像嵌入

若需更精准地控制图像显示,请使用 HTML 的 <img> 标签:

使用内联样式调整图片尺寸

使用 style 属性在 JSX 中编写内联样式来调整图片尺寸:

禁用缩放功能

要禁用图片点击时的默认缩放,请添加 noZoom 属性:
要让图片可点击并指向链接,请将图片包裹在 a(锚点)标签中,并添加 noZoom 属性:
位于锚点标签内的图像会自动显示指针光标,表示它们可点击。

明暗模式的图像

要在浅色和深色主题下显示不同的图像,请使用 Tailwind CSS 类:

视频

Mintlify 支持在 Markdown 中使用 HTML 标签,让你能更灵活地创建丰富内容。
请务必在 video 元素内提供备用文本内容,以便在不支持视频播放的浏览器中显示。

嵌入 YouTube 视频

使用 iframe 元素嵌入 YouTube 视频:

自托管视频

对于自托管视频对象,请使用 HTML <video> 元素:

自动播放视频

要让视频自动播放,请使用:
使用 JSX 语法时,将由两个单词组成的属性写成驼峰命名(camelCase):autoPlayplaysInlineallowFullScreen

iframe

使用 iframe 元素嵌入外部内容:

Frame 组件参考

了解如何使用 Frame 组件来呈现图像。