{
  "url": "https://unifast.dev/docs/packages/highlight/overview/",
  "locale": "en",
  "title": "@unifast/highlight",
  "description": "highlight.js-based syntax highlighting plugin for unifast via HAST transforms",
  "section": "packages",
  "body": "## Overview\n\n`@unifast/highlight` provides syntax highlighting powered by [lowlight](https://github.com/wooorm/lowlight) (a highlight.js wrapper). Unlike the built-in `syntect()` and `treeSitter()` plugins that run highlighting in Rust, this package applies highlighting as a JavaScript HAST transform after compilation — giving you access to highlight.js's extensive language and theme ecosystem.\n\n## Installation\n\n## Quick Start\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## How It Works\n\n1. The Rust compiler produces HAST output with un-highlighted `<pre><code>` blocks\n2. The `highlight()` plugin's `hastTransform` walks the HAST tree\n3. For each `<code>` element with a `language-*` class, lowlight highlights the code\n4. The highlighted HAST nodes replace the original children\n\nSince this runs as a HAST transform, the native Rust highlighting (`syntect` / `treeSitter`) must be disabled. The plugin automatically sets `highlight.enabled: false` in compile options.\n\n## Exports Summary\n\n| Export | Kind | Description |\n|--------|------|-------------|\n| `highlight` | function | Create a highlight.js HAST transform plugin |",
  "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"
    }
  ]
}