{
  "url": "https://unifast.dev/zh-CN/docs/packages/vite/overview/",
  "locale": "zh-CN",
  "title": "@unifast/vite",
  "description": "unifast 的 Vite 插件 —— 将 Markdown 和 MDX 文件转换为 JS 模块。",
  "section": "packages",
  "body": "## 概述\n\n`@unifast/vite` 是一个 Vite 插件，可将 `.md` 和 `.mdx` 文件转换为 JavaScript 模块。它将 unifast 的 Markdown/MDX 编译器整合进 Vite 的构建流程，让你可以在应用中直接 import Markdown 文件。\n\n## 安装\n\n`@unifast/node` 是可选的对等依赖 —— 当它可用时，插件会使用原生 Rust 编译器以获得最佳性能。若未安装它，`.md` 文件会回退到基础的 HTML 渲染，而 `.mdx` 文件则必须依赖它。\n\n## 快速开始\n\n```ts\n// vite.config.ts\n\nexport default defineConfig({\n  plugins: [\n    unifast({\n      md: {\n        // compile options for .md files\n      },\n      mdx: {\n        // compile options for .mdx files\n      },\n    }),\n  ],\n});\n```\n\n```ts\n// App.tsx\n\nconsole.log(doc.html);         // compiled HTML string\nconsole.log(doc.frontmatter);  // parsed frontmatter object\nconsole.log(doc.toc);          // table of contents entries\n```\n\n## 模块导出\n\n### `.md` 文件\n\n每个 `.md` 文件会被转换为一个包含以下导出的模块：\n\n| 导出 | 类型 | 描述 |\n|--------|------|-------------|\n| `html` | `string` | 编译后的 HTML 字符串 |\n| `frontmatter` | `Record<string, unknown>` | 解析后的 frontmatter 元数据 |\n| `toc` | `TocEntry[]` | 提取出的目录 |\n| `default` | `object` | 包含 `html`、`frontmatter` 和 `toc` 的对象 |\n\n### `.mdx` 文件\n\n每个 `.mdx` 文件会使用 React 的 `jsx-runtime` 编译为一个 JSX 模块。它默认导出一个 React 组件，并同时导出 `frontmatter` 和 `toc`。\n\n## 导出列表\n\n| 导出 | 类别 | 描述 |\n|--------|------|-------------|\n| `default`（unifastPlugin） | function | Vite 插件工厂函数 |\n| `UnifastPluginOptions` | type | 插件选项接口 |",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/docs/packages/vite/overview.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/ja/docs/packages/vite/overview.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/vite/overview.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/vite/overview.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/ko/docs/packages/vite/overview.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/fr/docs/packages/vite/overview.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/it/docs/packages/vite/overview.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/es/docs/packages/vite/overview.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/vite/overview.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/de/docs/packages/vite/overview.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/ru/docs/packages/vite/overview.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/hi/docs/packages/vite/overview.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/id/docs/packages/vite/overview.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/tr/docs/packages/vite/overview.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/vite/overview/",
      "api": "https://unifast.dev//api/vi/docs/packages/vite/overview.json"
    }
  ]
}