createShikiPlugin()

Cria um plugin de syntax highlighting baseado em Shiki. Uma função assíncrona que inicializa o highlighter do Shiki e retorna um UnifastPlugin com uma transformação HAST.

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

Assinatura

async function createShikiPlugin(
  options?: ShikiTransformerOptions,
): Promise<UnifastPlugin>

Parâmetros

options?

Configuração do Shiki (temas, linguagens)

Propriedade	Tipo	Padrão	Descrição
`themes`	`BundledTheme[]`	`["github-dark"]`	Temas Shiki a carregar
`defaultTheme`	`BundledTheme`	Primeiro tema em themes	Tema padrão para renderização
`langs`	`BundledLanguage[]`	`[]`	Linguagens a carregar. Apenas linguagens carregadas terão highlighting.

Uso

import { compile } from "@unifast/node";
import { createShikiPlugin } from "@unifast/shiki";

const shiki = await createShikiPlugin({
  themes: ["github-dark", "github-light"],
  defaultTheme: "github-dark",
  langs: ["typescript", "rust", "json", "html", "css"],
});

const result = compile(md, {
  plugins: [shiki],
});

console.log(result.output);
// Code blocks are highlighted with Shiki-generated <span> elements

Exemplos

Tema único

import { compile } from "@unifast/node";
import { createShikiPlugin } from "@unifast/shiki";

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

const result = compile("```ts\nconst x = 1;\n```", {
  plugins: [shiki],
});

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

Múltiplos temas

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

const shiki = await createShikiPlugin({
  themes: ["github-dark", "github-light", "dracula"],
  defaultTheme: "github-dark",
  langs: ["typescript", "rust", "python"],
});

// Use with compile() — defaultTheme is applied to code blocks

Com outros plugins

import { compile, gfm, frontmatter } from "@unifast/node";
import { createShikiPlugin } from "@unifast/shiki";

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

const result = compile(md, {
  plugins: [gfm(), frontmatter(), shiki],
});