GeneratorConfig

Configuration for the markdown generator. Defines generator name, project root, labels, and signature language.

Signature

interface GeneratorConfig {
  name: string;
  projectRoot: string;
  labels?: {
    parameters?: string;
    returns?: string;
    throws?: string;
    examples?: string;
    see?: string;
    version?: string;
    deprecated?: string;
    signature?: string;
    typedef?: string;
    properties?: string;
  };
  signatureLanguage?: string;
}

Properties

• nameRequired · string
  

  Name of the generator (e.g., 'vitepress', 'nextra')

• projectRootRequired · string
  

  Absolute path to the project root directory

• labels · object
  

  Custom labels for documentation sections

  • parameters · string
    

    Label for the parameters section

  • returns · string
    

    Label for the returns section

  • throws · string
    

    Label for the throws section

  • examples · string
    

    Label for the examples section

  • see · string
    

    Label for the see section

  • version · string
    

    Label for the version section

  • deprecated · string
    

    Label for the deprecated section

  • signature · string
    

    Label for the signature section

  • typedef · string
    

    Label for the typedef section

  • properties · string
    

    Label for the properties section

• signatureLanguage · string
  

  Language for code signature highlighting (e.g., 'typescript', 'tsx')