{
  "url": "https://unifast.dev/ja/docs/packages/shiki/overview/",
  "locale": "ja",
  "title": "@unifast/shiki",
  "description": "HAST 変換を通じて unifast に Shiki ベースのシンタックスハイライトを追加するプラグインです。",
  "section": "packages",
  "body": "## 概要\n\n`@unifast/shiki` は、[Shiki](https://shiki.style/) によるシンタックスハイライトを提供し、200 以上の言語と多彩なテーマをサポートします。組み込みの highlight プラグインとは異なり、Shiki は JavaScript の HAST 変換として動作し、`<pre><code>` ブロックをリッチにスタイリングされた出力に置き換えます。\n\n本プラグインは、二重処理を避けるために組み込みの Rust ハイライタを自動的に無効にします。\n\n## インストール\n\n## 型定義\n\n### ShikiTransformerOptions\n\n| プロパティ | 型 | デフォルト | 説明 |\n|----------|------|---------|-------------|\n| `themes` | `BundledTheme[]` | `[\"github-dark\"]` | 読み込む Shiki テーマ |\n| `defaultTheme` | `BundledTheme` | `themes` の最初のテーマ | レンダリングで使うデフォルトのテーマ |\n| `langs` | `BundledLanguage[]` | `[]` | 読み込む言語。読み込まれた言語のみがハイライトされます。 |\n\n> `BundledTheme` と `BundledLanguage` は `shiki` パッケージの型です。\n\n### ShikiTransformer\n\n| プロパティ | 型 | 説明 |\n|----------|------|-------------|\n| `transform` | `(hast: HastRoot) => HastRoot` | すべての `<pre><code class=\"language-*\">` ブロックに Shiki のハイライトを適用する |\n\n## エクスポート一覧\n\n| エクスポート | 種類 | 説明 |\n|--------|------|-------------|\n| `createShikiPlugin` | function | Shiki の UnifastPlugin を生成する (非同期) |\n| `createShikiTransformer` | function | スタンドアロンの Shiki トランスフォーマーを生成する (非同期) |\n| `ShikiTransformerOptions` | type | Shiki の設定オプション |\n| `ShikiTransformer` | type | トランスフォーマーのインターフェース |\n| `hastToHtml` | function | HAST から HTML へのシリアライザ (再エクスポート) |\n| `HastNode`, `HastRoot`, etc. | types | HAST のノード型 (再エクスポート) |",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/docs/packages/shiki/overview.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/ja/docs/packages/shiki/overview.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/shiki/overview.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/shiki/overview.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/ko/docs/packages/shiki/overview.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/fr/docs/packages/shiki/overview.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/it/docs/packages/shiki/overview.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/es/docs/packages/shiki/overview.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/shiki/overview.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/de/docs/packages/shiki/overview.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/ru/docs/packages/shiki/overview.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/hi/docs/packages/shiki/overview.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/id/docs/packages/shiki/overview.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/tr/docs/packages/shiki/overview.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/shiki/overview/",
      "api": "https://unifast.dev//api/vi/docs/packages/shiki/overview.json"
    }
  ]
}