shiki-transformer-fold

Code folding support for shiki.

Usage

Install the package:

# ✨ Auto-detect (supports npm, yarn, pnpm, deno and bun)
npx nypm install shiki-transformer-fold

Add the transformer

import { codeToHtml } from "shiki";
import {
  attachFoldToggleListener,
  transformerRenderHtmlFold,
} from "shiki-transformer-fold";

const html = await codeToHtml(code, {
  lang: "html",
  theme: "nord",
  transformers: [transformerRenderHtmlFold()],
});

// attach listeners to allow opening and closing the rendered code
// need to be called only once
attachFoldToggleListener();

Development

• Clone this repository
• Install latest LTS version of Node.js
• Enable Corepack using corepack enable
• Install dependencies using pnpm install
• Run interactive tests using pnpm dev

License

Published under the MIT license. Made by community 💛

🤖 auto updated with automd