MDX 使用示例:让文档变成可复用的页面
通过 Markdown + JSX 的组合展示 MDX 的优势:结构清晰、组件化、可复用,并提供丰富组件示例。
2026年1月2日
4 min read
MDX文档组件写作前端
MDX 将 Markdown 的可读性与 JSX 的可组合性合在一起,让内容既能写得快,又能长得像产品。
MDX 的核心优势
- 内容和组件同一处维护:文档里直接用 UI 组件,避免在说明里贴一大堆长得不像产品的截图。
- 结构化与可复用:组件可复用、可组合,维护时不必到处复制粘贴。
- 表达力更强:列表、表格、代码、提示块、按钮、卡片都能在一篇文档里共存。
- 样式一致性:统一的组件体系保证风格一致,不会出现文档与站点割裂的问题。
下面的内容会同时演示 Markdown 与 MDX 组件的混排效果。
一段快速示例(Markdown + JSX)
## 这是一个标题
<Callout type="tip" title="提示">
这是一段可以直接渲染的组件内容。
</Callout>
<Button variant="outline">立即试用</Button>MDX 还允许你在正文中插入表达式,比如:2 + 3 = {2 + 3}。
组件展示区
1. Callout 信息块
信息
用于解释概念、强调定义或补充背景。
技巧
用于提示最佳实践或提高效率的小窍门。
注意
用于提醒潜在问题或边界条件。
危险
用于强调必须避免的操作或严重后果。
2. Kbd 键盘提示
当你需要表达快捷键时,可以这样写:Cmd + K 或 Ctrl + S。
3. Badge 与 Button
MDX
可复用
注意事项
4. Cards + CardLink(卡片导航)
5. ButtonLink(可直接跳转的按钮)
阅读更多文章 访问 MDX 官网常用 Markdown 语法仍然可用
列表
- 任务清单
- 需求说明
- 版本日志
表格
| 能力点 | Markdown | MDX |
|---|---|---|
| 纯文本可读性 | 是 | 是 |
| 组件化表达 | 否 | 是 |
| 交互式组件 | 否 | 是 |
| 结构化复用 | 否 | 是 |
代码块
export function Hero() {
return (
<section className="space-y-4">
<h1 className="text-3xl font-semibold">用组件表达内容</h1>
<p className="text-muted-foreground">MDX 让文档像页面一样可控</p>
</section>
)
}适合使用 MDX 的场景
- 产品文档:需要统一视觉与结构的内容
- 设计系统:展示组件与用法的规范说明
- 博客/文章:希望文章具备强表达力与品牌一致性
小结
MDX 的核心价值在于内容即组件,既保留 Markdown 的易写性,又获得 React 组件的可组合能力。