{
  "url": "https://unifast.dev/zh-TW/docs/packages/vite/overview/",
  "locale": "zh-TW",
  "title": "@unifast/vite",
  "description": "unifast 的 Vite 外掛──將 Markdown 與 MDX 檔案轉換為 JS 模組",
  "section": "packages",
  "body": "## 概觀\n\n`@unifast/vite` 是一個 Vite 外掛，可將 `.md` 與 `.mdx` 檔案轉換為 JavaScript 模組。它將 unifast 的 Markdown/MDX 編譯器整合進 Vite 的建置管線，讓您可以在應用程式中直接匯入 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"
    }
  ]
}