@mui/internal-docs-infra/pipeline/syncTypes/generateTypesMarkdown.d.mts

MUI Infra - internal documentation creation tools.

import { type TypesMeta } from "../loadServerTypesMeta/index.mjs";
import { type OrganizeTypesResult } from "../loadServerTypesText/organizeTypesByExport.mjs";
/**
 * Options for generating types markdown.
 */
export interface GenerateTypesMarkdownOptions {
  /** The name/title to use for the markdown document */
  name: string;
  /** Pre-organized types from organizeTypesByExport */
  organized: OrganizeTypesResult<TypesMeta>;
  /** Map from flat type names to canonical dotted names */
  typeNameMap?: Record<string, string>;
  /** External types referenced in props/params but not publicly exported */
  externalTypes?: Record<string, string>;
  /**
   * Relative path to the types file (e.g., "react/components/accordion/types.mdx").
   * Used to generate a helpful hint in the autogenerated comment pointing users
   * to the validate command (e.g., `pnpm docs:validate <path>`).
   */
  path?: string;
}
export declare function generateTypesMarkdown(options: GenerateTypesMarkdownOptions): Promise<string>;