什么是MDX文件?
MDX 是一种结合了 Markdown 与 JSX 的文件格式,允许你在 Markdown 中直接嵌入 React 组件。 它广泛用于文档站点(如 Docusaurus、Next.js)、博客系统和静态网站生成器中。
为什么使用MDX?
- 保留 Markdown 的简洁书写体验
- 支持动态交互式内容(通过 React 组件)
- 适用于现代前端框架(如 Next.js、Gatsby)
如何编辑MDX文件?
1. 使用代码编辑器
推荐使用以下编辑器,并安装对应插件以获得语法高亮和智能提示:
- Visual Studio Code:安装
MDX插件 - WebStorm / IntelliJ IDEA:原生支持或通过插件
2. 基本语法示例
{`# 欢迎使用 MDX
这是一个普通的 Markdown 段落。
<Counter /> {/* 这是一个 React 组件 */}
你可以像写 JSX 一样写组件:
<Alert type="info">
这是一条提示信息!
</Alert>
`}
3. 在线编辑(可选)
虽然目前没有专门的“在线MDX编辑器”,但你可以:
- 使用 CodeSandbox 创建支持 MDX 的项目
- 先用 在线Word文档编辑 起草内容,再转换为 MDX
常见问题
Q:MDX 和 Markdown 有什么区别?
A:MDX 支持在 Markdown 中写 JSX,而标准 Markdown 不支持。
Q:哪些框架支持 MDX?
A:Next.js、Gatsby、Docusaurus、Astro、Nuxt 等主流框架均有良好支持。