createShikiTransformer()

Membuat transformer Shiki standalone untuk kontrol tingkat lebih rendah. Tidak seperti createShikiPlugin(), fungsi ini mengembalikan objek transformer mentah yang dapat Anda terapkan secara manual ke pohon HAST.

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

Signature

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

Parameter

options?

Konfigurasi Shiki (tema, bahasa)

PropertiTipeDefaultDeskripsi
themesBundledTheme[]["github-dark"]Tema Shiki yang akan dimuat
defaultThemeBundledThemeTema pertama dalam themesTema default untuk rendering
langsBundledLanguage[][]Bahasa yang akan dimuat. Hanya bahasa yang sudah dimuat yang akan ter-highlight.

Penggunaan

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

Contoh

Transformasi HAST manual

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

Dengan rendering React

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 });