{
  "url": "https://unifast.dev/zh-CN/docs/packages/vite/unifast-plugin/",
  "locale": "zh-CN",
  "title": "unifastPlugin()",
  "description": "创建一个 Vite 插件，将 Markdown 和 MDX 文件转换为可 import 的 JavaScript 模块。",
  "section": "packages",
  "body": "```ts\n\n```\n\n## 签名\n\n```ts\nfunction unifastPlugin(options?: UnifastPluginOptions): Plugin\n```\n\n## 参数\n\n### options?\n\n| 属性 | 类型 | 默认值 | 描述 |\n|----------|------|---------|-------------|\n| `md` | `CompileOptions` | `{}` | 作用于 `.md` 文件的编译选项 |\n| `mdx` | `CompileOptions` | 使用 `md` 选项 | 作用于 `.mdx` 文件的编译选项。未指定时会回退到 `md` |\n\n## 返回值\n\n一个 Vite `Plugin` 对象，具有以下字段：\n- **`name`**：`\"vite-plugin-unifast\"`\n- **`enforce`**：`\"pre\"` —— 在其他插件之前运行\n- **`transform`**：将 `.md` / `.mdx` 文件编译为 JS 模块\n- **`handleHotUpdate`**：在 Markdown 文件变更时触发 HMR\n\n## 用法\n\n```ts\n// vite.config.ts\n\nexport default defineConfig({\n  plugins: [\n    unifast({\n      md: {\n        plugins: [gfm(), frontmatter(), syntect()],\n      },\n    }),\n  ],\n});\n```\n\n## 示例\n\n### 为 MD 和 MDX 分别配置选项\n\n```ts\n\nexport default defineConfig({\n  plugins: [\n    unifast({\n      md: {\n        plugins: [gfm(), frontmatter()],\n      },\n      mdx: {\n        plugins: [gfm(), frontmatter()],\n        // MDX-specific options can differ\n      },\n    }),\n  ],\n});\n```\n\n### 在组件中导入 Markdown\n\n```ts\n\n// doc.html — compiled HTML string\n// doc.frontmatter — parsed frontmatter object\n// doc.toc — table of contents entries\n```",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/ja/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/ko/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/fr/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/it/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/es/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/de/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/ru/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/hi/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/id/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/tr/docs/packages/vite/unifast-plugin.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/vite/unifast-plugin/",
      "api": "https://unifast.dev//api/vi/docs/packages/vite/unifast-plugin.json"
    }
  ]
}