createShikiTransformer()

Erstellt einen eigenständigen Shiki-Transformer für Low-Level-Kontrolle. Im Gegensatz zu createShikiPlugin() gibt diese Funktion ein rohes Transformer-Objekt zurück, das Sie manuell auf HAST-Bäume anwenden können.

import { createShikiTransformer } from "@unifast/shiki";

Signatur

async function createShikiTransformer(
  options?: ShikiTransformerOptions,
): Promise<ShikiTransformer>

Parameter

options?

Shiki-Konfiguration (Themes, Sprachen)

Eigenschaft	Typ	Standard	Beschreibung
`themes`	`BundledTheme[]`	`["github-dark"]`	Zu ladende Shiki-Themes
`defaultTheme`	`BundledTheme`	Erstes Theme in themes	Standard-Theme für das Rendering
`langs`	`BundledLanguage[]`	`[]`	Zu ladende Sprachen. Nur geladene Sprachen werden hervorgehoben.

Verwendung

import { compile } from "@unifast/node";
import { createShikiTransformer } from "@unifast/shiki";
import type { HastRoot } from "@unifast/core";

const transformer = await createShikiTransformer({
  themes: ["github-dark", "github-light"],
  defaultTheme: "github-dark",
  langs: ["typescript", "rust", "json"],
});

const result = compile(md, { outputKind: "hast" });
const hast: HastRoot = JSON.parse(result.output as string);
const highlighted = transformer.transform(hast);

console.log(highlighted);
// HAST tree with Shiki-highlighted code blocks

Beispiele

Manuelle HAST-Transformation

import { compile } from "@unifast/node";
import { createShikiTransformer } from "@unifast/shiki";
import { hastToHtml } from "@unifast/core";
import type { HastRoot } from "@unifast/core";

const transformer = await createShikiTransformer({
  themes: ["github-dark"],
  langs: ["typescript"],
});

const result = compile("```ts\nconst x = 1;\n```", { outputKind: "hast" });
const hast: HastRoot = JSON.parse(result.output as string);
const highlighted = transformer.transform(hast);
const html = hastToHtml(highlighted);

console.log(html);
// <pre> with Shiki-highlighted <span> elements

Mit React-Rendering

import { createElement, Fragment } from "react";
import { compile } from "@unifast/node";
import { createShikiTransformer } from "@unifast/shiki";
import { hastToReact } from "@unifast/react";
import type { HastRoot } from "@unifast/core";

const transformer = await createShikiTransformer({
  themes: ["github-dark"],
  langs: ["typescript"],
});

const result = compile(md, { outputKind: "hast" });
const hast: HastRoot = JSON.parse(result.output as string);
const highlighted = transformer.transform(hast);
const element = hastToReact(highlighted, { createElement, Fragment });