{
  "url": "https://unifast.dev/ja/docs/packages/vite/overview/",
  "locale": "ja",
  "title": "@unifast/vite",
  "description": "unifast 向けの Vite プラグインです。Markdown および MDX ファイルを JS モジュールへ変換します。",
  "section": "packages",
  "body": "## 概要\n\n`@unifast/vite` は `.md` および `.mdx` ファイルを JavaScript モジュールに変換する Vite プラグインです。unifast の Markdown/MDX コンパイラを Vite のビルドパイプラインへ統合し、アプリケーション内で Markdown ファイルを直接インポートできるようにします。\n\n## インストール\n\n`@unifast/node` はピア依存 (任意) です。利用可能な場合、プラグインは最大限のパフォーマンスのためにネイティブ Rust コンパイラを使用します。利用できない場合、`.md` ファイルは基本的な HTML レンダリングにフォールバックし、`.mdx` ファイルには `@unifast/node` が必須となります。\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"
    }
  ]
}