Class Generators

Collection of docs generators

Implements

GeneratorBuilder

Index

Constructors

Methods

get register fromConfig

Constructors

constructor

new Generators(): Generators
Returns Generators

Methods

get

get(entity: Entity): GeneratorBase
Returns the generator for a given TechDocs entity
Parameters
- entity: Entity
  A TechDocs entity instance
Returns GeneratorBase
Implementation of GeneratorBuilder.get
- Defined in plugins/techdocs-node/src/stages/generate/generators.ts:71

register

register(generatorKey: string, generator: GeneratorBase): void
Register a generator in the generators collection
Parameters
- generatorKey: string
  Unique identifier for the generator
- generator: GeneratorBase
  The generator instance to register
Returns void
Implementation of GeneratorBuilder.register
- Defined in plugins/techdocs-node/src/stages/generate/generators.ts:63

`Static`fromConfig

fromConfig(
    config: Config,
    options: {
        containerRunner?: TechDocsContainerRunner;
        customGenerator?: TechdocsGenerator;
        logger: LoggerService;
    },
): Promise<GeneratorBuilder>
Returns a generators instance containing a generator for TechDocs
Parameters
- config: Config
  A Backstage configuration
- options: {
      containerRunner?: TechDocsContainerRunner;
      customGenerator?: TechdocsGenerator;
      logger: LoggerService;
  }
  Options to configure the TechDocs generator
Returns Promise<GeneratorBuilder>
- Defined in plugins/techdocs-node/src/stages/generate/generators.ts:41