{
  "url": "https://unifast.dev/zh-TW/docs/packages/shiki/overview/",
  "locale": "zh-TW",
  "title": "@unifast/shiki",
  "description": "透過 HAST 轉換為 unifast 提供以 Shiki 為核心的語法高亮外掛",
  "section": "packages",
  "body": "## 概觀\n\n`@unifast/shiki` 透過 [Shiki](https://shiki.style/) 提供語法高亮功能，支援 200 種以上的語言與多樣的佈景主題。與內建的高亮外掛不同，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"
    }
  ]
}