{
  "url": "https://unifast.dev/zh-CN/docs/packages/highlight/overview/",
  "locale": "zh-CN",
  "title": "@unifast/highlight",
  "description": "基于 highlight.js 的 unifast 语法高亮插件，通过 HAST 转换实现。",
  "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-*` 类名的 `<code>` 元素，lowlight 都会对其中的代码进行高亮\n4. 高亮后的 HAST 节点会替换原有的子节点\n\n由于本插件以 HAST 转换的形式运行，原生 Rust 高亮（`syntect` / `treeSitter`）必须被禁用。该插件会自动在编译选项中设置 `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"
    }
  ]
}