Options

The default configuration is intentionally usable without setup. Override only the ownership, diagnostics, or naming behavior your pipeline needs.

type RehypeCodeGroupOptions = {
  assets?:
    | "inline"
    | "none"
    | { mode: "inline"; nonce?: string }
    | {
        mode: "external";
        nonce?: string;
        scriptSrc: string;
        stylesheetHref: string;
      };
  customClassNames?: Partial<ClassNames>;
  diagnostics?: "warn" | "error" | "silent";
  idPrefix?: string;
  labelResolver?: (label: string) => string;
};

assets

Default: "inline".

customClassNames

Add classes for codeGroupClass, tabContainerClass, tabClass, activeTabClass, blockContainerClass, and activeBlockClass. Defaults remain present as stable client hooks.

diagnostics

Default: "warn".

idPrefix

Default: "rcg". Generated IDs are deterministic within each transformation. Set a unique prefix when separately compiled fragments will be combined in one document.

labelResolver

Default: commonLabelResolver. Receives each display label and returns the rendered label. Use fullEmojiResolver from rehype-code-group/emoji for the complete shortcode catalog.

Browser client

import {
  initCodeGroups,
  type CodeGroupChangeDetail,
} from "rehype-code-group/client";
 
const cleanup
 = initCodeGroups(document);
cleanup();

Repeated calls for the same root return the same cleanup function. The client automatically initializes when imported in a browser.

Package-manager options

type PackageManagerOptions = {
  diagnostics?: "warn" | "error" | "silent";
  packageManagers?: Array<"npm" | "pnpm" | "yarn" | "bun">;
};