TechdocsGenerator
Home > @backstage/plugin-techdocs-node > TechdocsGenerator
Generates documentation files
Signature:
class TechdocsGenerator implements GeneratorBase
Implements: GeneratorBase
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(options) | Constructs a new instance of the TechdocsGenerator class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| defaultDockerImage |
| (not declared) | The default docker image (and version) used to generate content. Public and static so that techdocs-node consumers can use the same version. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| fromConfig(config, options) | static | Returns a instance of TechDocs generator |
| run(options) | Runs the generator with the values |