Skip to main content

Generators.fromConfig()

Home > @backstage/plugin-techdocs-node > Generators > fromConfig

Returns a generators instance containing a generator for TechDocs

Signature:

static fromConfig(config: Config, options: {
logger: Logger;
containerRunner: ContainerRunner;
customGenerator?: TechdocsGenerator;
}): Promise<GeneratorBuilder>;

Parameters

ParameterTypeDescription
configConfigA Backstage configuration
options{ logger: Logger; containerRunner: ContainerRunner; customGenerator?: TechdocsGenerator; }Options to configure the TechDocs generator

Returns:

Promise<GeneratorBuilder>