{
  "url": "https://unifast.dev/zh-CN/docs/guides/mdx/",
  "locale": "zh-CN",
  "title": "使用 MDX",
  "description": "使用 unifast 编译 MDX，让你可以在 Markdown 中编写 JSX 表达式和 import 语句，并通过 React 或其他 JSX 运行时进行渲染。",
  "section": "guides",
  "body": "MDX 让你可以在 Markdown 中编写 JSX 表达式和 import 语句。unifast 会将 MDX 编译为 JavaScript 模块，可通过 React 或其他 JSX 运行时进行渲染。\n\n### 安装\n\n### 基本用法\n\n```ts\n\nconst source = `\n# Hello\n\nexport const meta = { title: \"My Page\" };\n`;\n\nconst result = compile(source, { inputKind: \"mdx\" });\n// result.output is a JavaScript module string\n```\n\n### MDX 的工作方式\n\nMDX 在 Markdown 的基础上扩展了两项能力：\n\n1. **JSX 表达式** —— 在正文中内联使用组件。\n2. **ESM 导入/导出** —— 导入组件、导出元数据。\n\n编译器按照以下步骤处理 MDX：\n\n```\nMDX source\n  → Parse (Markdown + JSX + ESM)\n  → MdAst with JSX/ESM nodes\n  → Lower to HAst\n  → Emit as JavaScript module\n```\n\n输出是一个 JavaScript 模块，其中默认导出一个函数，该函数接受 `components` 属性用于注入组件。\n\n### 与 React 配合使用\n\n```ts\n\nconst source = `# Hello\\n\\nThis is **MDX**.`;\n\nconst result = compile(source, { inputKind: \"mdx\" });\nconst Component = compileToReact(result);\n\n// Render in your React app\n\n```\n\n### 在 MDX 中使用 Frontmatter\n\n将 MDX 与 frontmatter 插件结合使用即可提取元数据：\n\n```ts\n\nconst source = `---\ntitle: My Article\nauthor: Jane\n---\n\n# {frontmatter.title}\n\nWritten by {frontmatter.author}.\n`;\n\nconst result = compile(source, {\n  inputKind: \"mdx\",\n  plugins: [frontmatter()],\n});\n\nconsole.log(result.frontmatter);\n// { title: \"My Article\", author: \"Jane\" }\n```\n\n### 参见\n\n- [compile()](/docs/packages/node/compile) —— 完整的 API 参考\n- [React 集成](/docs/guides/react) —— 使用 React 渲染 MDX",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/guides/mdx/",
      "api": "https://unifast.dev//api/docs/guides/mdx.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/guides/mdx/",
      "api": "https://unifast.dev//api/ja/docs/guides/mdx.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/guides/mdx/",
      "api": "https://unifast.dev//api/zh-CN/docs/guides/mdx.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/guides/mdx/",
      "api": "https://unifast.dev//api/zh-TW/docs/guides/mdx.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/guides/mdx/",
      "api": "https://unifast.dev//api/ko/docs/guides/mdx.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/guides/mdx/",
      "api": "https://unifast.dev//api/fr/docs/guides/mdx.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/guides/mdx/",
      "api": "https://unifast.dev//api/it/docs/guides/mdx.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/guides/mdx/",
      "api": "https://unifast.dev//api/es/docs/guides/mdx.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/guides/mdx/",
      "api": "https://unifast.dev//api/pt-BR/docs/guides/mdx.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/guides/mdx/",
      "api": "https://unifast.dev//api/de/docs/guides/mdx.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/guides/mdx/",
      "api": "https://unifast.dev//api/ru/docs/guides/mdx.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/guides/mdx/",
      "api": "https://unifast.dev//api/hi/docs/guides/mdx.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/guides/mdx/",
      "api": "https://unifast.dev//api/id/docs/guides/mdx.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/guides/mdx/",
      "api": "https://unifast.dev//api/tr/docs/guides/mdx.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/guides/mdx/",
      "api": "https://unifast.dev//api/vi/docs/guides/mdx.json"
    }
  ]
}