组件概览

可折叠的内容区块，读者可展开查看详细信息。适用于常见问题、功能列表和配置选项。

可点击的样式化容器，支持图标、图片、链接和行动号召，可排列成网格布局。

响应式网格布局，可将卡片、磁贴和其他内容并排放置。会根据屏幕尺寸自动调整。

Frame 将图片和演示内容包裹在带边框的容器中，并可选择添加说明文字。

将警告或快速参考等自定义内容固定在侧边栏中，读者滚动页面时内容始终可见。

用于设置流程、教程和故障排除的编号分步指南，支持图标、代码块和嵌套内容。

用于互斥内容（如包管理器或编程语言）的可切换面板。相同的标签页标题会在整个页面中同步。

磁贴以带样式的图案背景和突出的图片区域展示内容预览。适用于集成、模板或视觉图库。

以可交互的展开/折叠和键盘导航展示文件和文件夹层级结构。适用于记录项目结构。

为读者所选的框架或语言显示内容。整个区块会随所选项切换。

用于状态、分类和元数据的行内标签，提供 11 种颜色变体、4 种尺寸、图标、药丸形/圆角形状和描边轮廓。

Note、Tip、Warning、Danger、Check 以及自定义 Callout 组件，用于突出关键信息。

Expandable 为主内容流之外的可选内容创建显示/隐藏切换。

悬停时显示定义和上下文。定义术语、解释缩写，或链接到相关内容，同时不会让页面显得杂乱。

时间线式的更新日志条目，包含日期、描述和分类标签。条目会显示在目录中。

在同一页面上为人类读者和 AI 代理显示不同内容。仅供代理使用的上下文、说明和定义不会出现在渲染后的文档中。

以标签页界面显示代码块。以多种语言（如 cURL、Python 和 JavaScript）展示同一操作。

在桌面端将代码块（可选语言标签页）固定在粘性右侧边栏中，读者滚动时始终保持可见。

使用 ParamField 和 ResponseField 组件记录 API 参数和响应字段，包括类型、默认值和嵌套对象。

使用 Prompt 呈现可复用的 AI 指令，支持复制、内置的打开操作、自定义目标位置、图标和紧凑显示选项。

将数据组织为行和列。可使用 Markdown 表格或 Table 组件，支持排序、高亮和跨行跨列。

Color 组件可为设计系统、品牌指南或任何颜色规范展示调色板。

根据基于文本的 Mermaid 语法渲染流程图、时序图、时间线、饼图等。图表在构建时生成为 SVG。

根据基于文本的 D2 语法渲染架构图、流程图、时序图和 SQL 模型。图表渲染为跟随站点主题的 SVG。

使用 EmailSubscribe 组件在任意文档页面添加新闻通讯或更新日志订阅表单：为七家服务商提供原生采集，其他服务商则使用嵌入方式。

使用 Widget MDX 组件在文档中嵌入实时的 What's New 小组件演示：一个触发按钮，点击后在弹窗中打开您的更新日志，无需 script 标签。