Version: Next

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: LoggerService;
        containerRunner?: TechDocsContainerRunner;
        customGenerator?: TechdocsGenerator;
    }): Promise<GeneratorBuilder>;

Parameters

Parameter	Type	Description
config	Config	A Backstage configuration
options	{ logger: LoggerService; containerRunner?: TechDocsContainerRunner; customGenerator?: TechdocsGenerator; }	Options to configure the TechDocs generator

Returns:

Promise<GeneratorBuilder>

Parameters​

Parameters