{
  "url": "https://unifast.dev/docs/packages/shiki/create-shiki-plugin/",
  "locale": "en",
  "title": "createShikiPlugin()",
  "description": "Create a Shiki-powered syntax highlighting plugin. An async function that initializes the Shiki highlighter and returns a UnifastPlugin with a HAST transform.",
  "section": "packages",
  "body": "```ts\n\n```\n\n## Signature\n\n```ts\nasync function createShikiPlugin(\n  options?: ShikiTransformerOptions,\n): Promise<UnifastPlugin>\n```\n\n## Parameters\n\n### options?\n\nShiki configuration (themes, languages)\n\n| Property | Type | Default | Description |\n|----------|------|---------|-------------|\n| `themes` | `BundledTheme[]` | `[\"github-dark\"]` | Shiki themes to load |\n| `defaultTheme` | `BundledTheme` | First theme in themes | Default theme for rendering |\n| `langs` | `BundledLanguage[]` | `[]` | Languages to load. Only loaded languages will be highlighted. |\n\n## Usage\n\n```ts\n\nconst shiki = await createShikiPlugin({\n  themes: [\"github-dark\", \"github-light\"],\n  defaultTheme: \"github-dark\",\n  langs: [\"typescript\", \"rust\", \"json\", \"html\", \"css\"],\n});\n\nconst result = compile(md, {\n  plugins: [shiki],\n});\n\nconsole.log(result.output);\n// Code blocks are highlighted with Shiki-generated <span> elements\n```\n\n## Examples\n\n### Single theme\n\n```ts\n\nconst shiki = await createShikiPlugin({\n  themes: [\"github-dark\"],\n  langs: [\"typescript\"],\n});\n\nconst result = compile(\"```ts\\nconst x = 1;\\n```\", {\n  plugins: [shiki],\n});\n\nconsole.log(result.output);\n// <pre> with Shiki-highlighted <span> elements\n```\n\n### Multiple themes\n\n```ts\n\nconst shiki = await createShikiPlugin({\n  themes: [\"github-dark\", \"github-light\", \"dracula\"],\n  defaultTheme: \"github-dark\",\n  langs: [\"typescript\", \"rust\", \"python\"],\n});\n\n// Use with compile() — defaultTheme is applied to code blocks\n```\n\n### With other plugins\n\n```ts\n\nconst shiki = await createShikiPlugin({\n  themes: [\"github-dark\"],\n  langs: [\"typescript\"],\n});\n\nconst result = compile(md, {\n  plugins: [gfm(), frontmatter(), shiki],\n});\n```",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/ja/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/ko/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/fr/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/it/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/es/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/de/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/ru/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/hi/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/id/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/tr/docs/packages/shiki/create-shiki-plugin.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/shiki/create-shiki-plugin/",
      "api": "https://unifast.dev//api/vi/docs/packages/shiki/create-shiki-plugin.json"
    }
  ]
}