{
  "url": "https://unifast.dev/zh-TW/docs/packages/highlight/overview/",
  "locale": "zh-TW",
  "title": "@unifast/highlight",
  "description": "透過 HAST 轉換為 unifast 提供以 highlight.js 為核心的語法高亮外掛",
  "section": "packages",
  "body": "## 概觀\n\n`@unifast/highlight` 透過 [lowlight](https://github.com/wooorm/lowlight)（highlight.js 的封裝）提供語法高亮功能。與在 Rust 中執行高亮的內建 `syntect()` 與 `treeSitter()` 外掛不同，本套件會在編譯完成後以 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-*` class 的 `<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"
    }
  ]
}