一份简洁明了的初学者指南
MDX 是一种结合了 Markdown 的简洁语法和 JSX 的强大功能的格式,广泛用于 React 项目、静态网站生成器(如 Next.js、Gatsby)中。本文将介绍如何创建和生成 MDX 文件。
MDX 允许你在 Markdown 文档中直接嵌入 JSX 组件。这意味着你可以在写内容的同时,插入交互式 React 组件,非常适合文档、博客和技术写作。
import { Chart } from './components/Chart'
# 我的文档
这是一个普通的段落。
另一个段落。
1. 安装必要工具
确保你已安装 Node.js 和 npm。然后在项目中安装 MDX 支持:
npm install @mdx-js/loader @mdx-js/react
2. 创建 .mdx 文件
使用任意文本编辑器(如 VS Code),创建一个以 .mdx
结尾的文件,例如:article.mdx
。
3. 编写内容
在文件中混合使用 Markdown 和 JSX:
# 标题
这是使用 Markdown 写的段落。
export const Highlight = ({ children }) => (
<span style={{ backgroundColor: 'yellow' }}>
{children}
</span>
);
这是高亮的内容 。
确保你的构建工具(Webpack、Vite 等)已正确配置 MDX 加载器。否则 .mdx 文件将无法被识别。