{
  "url": "https://unifast.dev/ja/docs/packages/highlight/overview/",
  "locale": "ja",
  "title": "@unifast/highlight",
  "description": "HAST 変換を通じて unifast に highlight.js ベースのシンタックスハイライトを追加するプラグインです。",
  "section": "packages",
  "body": "## 概要\n\n`@unifast/highlight` は、[lowlight](https://github.com/wooorm/lowlight) (highlight.js のラッパー) を利用したシンタックスハイライトを提供します。組み込みの `syntect()` や `treeSitter()` プラグインが Rust 内部でハイライトを実行するのに対し、本パッケージはコンパイル後に JavaScript の HAST 変換としてハイライトを適用します。これにより highlight.js の豊富な言語とテーマのエコシステムを利用できます。\n\n## インストール\n\n## クイックスタート\n\n```ts\n\nconst md = `\n\\`\\`\\`javascript\nconst x = 42;\nconsole.log(x);\n\\`\\`\\`\n`;\n\nconst result = compile(md, {\n  plugins: [highlight()],\n});\n\nconsole.log(result.output);\n// Code blocks are highlighted with highlight.js CSS classes\n```\n\n## しくみ\n\n1. Rust コンパイラは、ハイライトされていない `<pre><code>` ブロックを含む HAST を出力します\n2. `highlight()` プラグインの `hastTransform` が HAST ツリーを走査します\n3. `language-*` クラスを持つ各 `<code>` 要素に対して、lowlight がコードをハイライトします\n4. ハイライトされた HAST ノードが元の子ノードを置き換えます\n\nこの処理は HAST 変換として実行されるため、ネイティブの Rust ハイライト (`syntect` / `treeSitter`) を無効にする必要があります。本プラグインは compile オプションで自動的に `highlight.enabled: false` を設定します。\n\n## エクスポート一覧\n\n| エクスポート | 種類 | 説明 |\n|--------|------|-------------|\n| `highlight` | function | highlight.js の HAST 変換プラグインを生成する |",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/docs/packages/highlight/overview.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/ja/docs/packages/highlight/overview.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/highlight/overview.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/highlight/overview.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/ko/docs/packages/highlight/overview.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/fr/docs/packages/highlight/overview.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/it/docs/packages/highlight/overview.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/es/docs/packages/highlight/overview.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/highlight/overview.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/de/docs/packages/highlight/overview.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/ru/docs/packages/highlight/overview.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/hi/docs/packages/highlight/overview.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/id/docs/packages/highlight/overview.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/tr/docs/packages/highlight/overview.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/highlight/overview/",
      "api": "https://unifast.dev//api/vi/docs/packages/highlight/overview.json"
    }
  ]
}