{
  "url": "https://unifast.dev/zh-CN/docs/packages/shiki/overview/",
  "locale": "zh-CN",
  "title": "@unifast/shiki",
  "description": "基于 Shiki 的 unifast 语法高亮插件，通过 HAST 转换实现。",
  "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` 等 | 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"
    }
  ]
}