什么是MDX文件?
MDX 是一种结合了 Markdown 与 JSX 的文件格式,允许你在 Markdown 中直接嵌入 React 组件。它常用于文档站点、博客系统(如 Next.js、Gatsby、Docusaurus 等)中,以实现更丰富的交互内容。
编辑MDX文件的基本语法
MDX 文件扩展名为 .mdx,其语法包括:
- 标准 Markdown:如标题、列表、链接、图片等。
- 内联 JSX:可以在任意位置插入 React 组件,例如:
{``} - 导入语句:支持 ES 模块导入,例如:
{`import MyComponent from './MyComponent';`}
推荐的编辑工具
- VS Code:安装 MDX 插件 可获得语法高亮和智能提示。
- WebStorm / IntelliJ IDEA:对 JSX 和 Markdown 均有良好支持。
- 在线编辑器:部分静态站点平台(如 Vercel + Next.js)提供在线 MDX 编辑功能。
简单示例
{`---
title: 我的第一篇MDX文章
---
import Alert from './components/Alert';
# 欢迎使用 MDX!
这是一个普通的段落。
这是用 React 组件渲染的提示框!
`}
注意事项
- 确保你的构建工具(如 Webpack、Vite)已配置 MDX 加载器。
- 避免在 Markdown 区域直接写未闭合的 JSX 标签。
- 组件必须在使用前导入,否则会报错。