@mui/internal-docs-infra/pipeline/transformHtmlCodeInline/transformHtmlCodeInline.d.mts

MUI Infra - internal documentation creation tools.

import type { Root as HastRoot } from 'hast';
/**
 * Options for the transformHtmlCodeInline plugin.
 */
export interface TransformHtmlCodeInlineOptions {
  /**
   * When true, also processes code elements inside pre elements.
   * By default, code inside pre is skipped (handled by transformHtmlCodeBlock).
   * When enabled, code inside pre will NOT get the data-inline attribute.
   * @default false
   */
  includePreElements?: boolean;
}
/**
 * A rehype plugin that applies inline syntax highlighting to code elements.
 * Unlike transformHtmlCodeBlock, this does NOT add line gutters or precomputed data.
 * It's meant for inline code snippets that should be highlighted but remain lightweight.
 *
 * Processes code elements and replaces their text content with syntax-highlighted HAST nodes.
 *
 * @param options - Configuration options for the plugin
 * @returns A unified transformer function
 */
export default function transformHtmlCodeInline(options?: TransformHtmlCodeInlineOptions): (tree: HastRoot) => Promise<void>;