Code Enhance

Enhanced code blocks: Shiki highlighting plus a header with copy, wrap, and collapse controls.

日本語

Overview

codeEnhance() wraps rehype-pretty-code (Shiki) and post-processes each figure into .rr-code with a header and action buttons. The client entry wires up the buttons.

Usage

import { defineConfig } from "@riebeckite/core";
import { codeEnhance } from "@riebeckite/plugin-code-enhance";
 
export default defineConfig({
  // ...
  plugins: [
    codeEnhance({
      theme: { light: "github-light", dark: "github-dark" },
      lineNumbers: true,
      copyButton: true,
      filename: true,
      lineHighlight: true,
      diffHighlight: true,
      wrapToggle: true,
    }),
  ],
});

Features

• Syntax highlighting via Shiki (rehype-pretty-code)
• Header with the file name (code block title, falling back to the language) and action buttons
• Copy button with "Copied" feedback (client)
• Wrap toggle (client)
• Collapse / expand button (opt-in, client)
• Line numbers (data-line-number gutter)
• Line and character highlighting from pretty-code meta ({1,3}, [/re/])
• Diff coloring for lines starting with + / -
• Terminal styling for bash, console, sh, shell, terminal, zsh (inverted palette) with a $ prompt prefix on non-empty lines
• Focusable <pre> (tabindex="0") for keyboard scrolling

Options

Client

codeEnhance() forwards copyLabel / copiedLabel to the client entry. initCodeEnhance(options?) installs a document-level click handler for copy, wrap, and collapse buttons.

Exports

• codeEnhance(options?) — plugin factory
• rehypeCodeEnhance(options?) — rehype transform
• initCodeEnhance(options?) — client initializer
• DEFAULT_COPY_LABEL, DEFAULT_COPIED_LABEL — default copy labels
• Types: CodeEnhanceOptions, CodeEnhanceClientOptions, CodeEnhanceTheme

See also

• Plugin guide