{
  "url": "https://unifast.dev/docs/packages/vite/overview/",
  "locale": "en",
  "title": "@unifast/vite",
  "description": "Vite plugin for unifast — transform Markdown and MDX files into JS modules",
  "section": "packages",
  "body": "## Overview\n\n`@unifast/vite` is a Vite plugin that transforms `.md` and `.mdx` files into JavaScript modules. It integrates unifast's Markdown/MDX compiler into the Vite build pipeline, enabling you to import Markdown files directly in your application.\n\n## Installation\n\n`@unifast/node` is a peer dependency (optional) — when available, the plugin uses the native Rust compiler for maximum performance. Without it, `.md` files fall back to basic HTML rendering, and `.mdx` files require it.\n\n## Quick Start\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## Module Exports\n\n### `.md` files\n\nEach `.md` file is transformed into a module with the following exports:\n\n| Export | Type | Description |\n|--------|------|-------------|\n| `html` | `string` | Compiled HTML string |\n| `frontmatter` | `Record<string, unknown>` | Parsed frontmatter metadata |\n| `toc` | `TocEntry[]` | Extracted table of contents |\n| `default` | `object` | Object containing `html`, `frontmatter`, and `toc` |\n\n### `.mdx` files\n\nEach `.mdx` file is compiled to a JSX module using React's `jsx-runtime`. It exports a default React component along with `frontmatter` and `toc`.\n\n## Exports Summary\n\n| Export | Kind | Description |\n|--------|------|-------------|\n| `default` (unifastPlugin) | function | Vite plugin factory |\n| `UnifastPluginOptions` | type | Plugin options interface |",
  "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"
    }
  ]
}