@backstage/plugin-techdocs-node 0.0.0-nightly-20260928023907 → 0.0.0-nightly-20261028022344

package/CHANGELOG.md

@@ -1,19 +1,86 @@
 # @backstage/plugin-techdocs-node
 
-## 0.0.0-nightly-20260928023907
+## 0.0.0-nightly-20261028022344
+
+### Minor Changes
+
+- a4604d2: Added a new `@backstage/plugin-techdocs-node/alpha` entry point with building blocks for implementing additional documentation engines in separate modules: `createDockerContainerRunner`, `createOrUpdateMetadata`, `storeEtagMetadata`, `runCommand`, `validateInputDirectory`, `patchIndexPreBuild`, and the `mkdocs.yml` helpers `MKDOCS_SCHEMA`, `validateMkdocsYaml` and `sanitizeMkdocsYml`. These are alpha and may change in minor releases.
+
+### Patch Changes
+
+- 686d3cb: Fixed TechDocs served from Azure Blob Storage or Google Cloud Storage keeping storage connections open when a browser navigates away before a file is fully loaded. Errors that occur while streaming a file from Azure Blob Storage are now also logged and handled, instead of being left unhandled.
+- 2e98895: Fixed TechDocs served from AWS S3 leaking S3 connections when a browser navigates away before a file is fully loaded. Over time the connection pool was exhausted and all TechDocs pages failed to load with `Socket timed out without establishing a connection` errors until the backend was restarted.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.0.0-nightly-20261028022344
+  - @backstage/integration@2.1.3
+  - @backstage/catalog-model@1.10.2
+  - @backstage/config@1.3.10
+  - @backstage/errors@1.3.2
+  - @backstage/integration-aws-node@0.2.3
+  - @backstage/plugin-search-common@1.2.26
+  - @backstage/plugin-techdocs-common@0.1.2
+
+## 2.2.0-next.0
+
+### Minor Changes
+
+- a4604d2: Added a new `@backstage/plugin-techdocs-node/alpha` entry point with building blocks for implementing additional documentation engines in separate modules: `createDockerContainerRunner`, `createOrUpdateMetadata`, `storeEtagMetadata`, `runCommand`, `validateInputDirectory`, `patchIndexPreBuild`, and the `mkdocs.yml` helpers `MKDOCS_SCHEMA`, `validateMkdocsYaml` and `sanitizeMkdocsYml`. These are alpha and may change in minor releases.
+
+### Patch Changes
+
+- 686d3cb: Fixed TechDocs served from Azure Blob Storage or Google Cloud Storage keeping storage connections open when a browser navigates away before a file is fully loaded. Errors that occur while streaming a file from Azure Blob Storage are now also logged and handled, instead of being left unhandled.
+- 2e98895: Fixed TechDocs served from AWS S3 leaking S3 connections when a browser navigates away before a file is fully loaded. Over time the connection pool was exhausted and all TechDocs pages failed to load with `Socket timed out without establishing a connection` errors until the backend was restarted.
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.11.1-next.0
+
+## 2.1.0
+
+### Minor Changes
+
+- 4d4f987: Add engine abstraction layer for multi-engine TechDocs support. Introduces `--engine` flag, engine config map, generator registry with `backstage.io/techdocs-engine` annotation support, `engine` field in `techdocs_metadata.json`, `serve:raw` command, and live-reload adapter interface. MkDocs remains the default with no behavior change.
+
+  The built-in generator is now registered under `mkdocs`; the previous `techdocs` key is kept as an alias, so existing `generators.register('techdocs', ...)` calls continue to work. The CLI's `--engine` flag takes precedence over the `backstage.io/techdocs-engine` annotation for all commands, and `serve:mkdocs` and the `--mkdocs-parameter-*` flags now print deprecation warnings.
 
 ### Patch Changes
 
 - 9fc5387: Improved handling of mapping-style Markdown extension configuration.
+- 0fd5fe5: Fixed TechDocs allowing `custom_icons` paths in `mkdocs.yml` that resolve outside the documentation input directory. A `custom_icons` option with such a path is now removed from the configuration with a warning.
+- 8a37336: Fixed TechDocs generation rejecting `mkdocs.yml` files that use the emoji indexes and generators or the `pymdownx.superfences` custom fence formats documented by mkdocs-material, pymdown-extensions and mkdocs-mermaid2.
+- 76ac6ed: Updated dependency `js-yaml` to `^5.0.0`.
 - Updated dependencies
-  - @backstage/integration@0.0.0-nightly-20260928023907
-  - @backstage/config@0.0.0-nightly-20260928023907
-  - @backstage/errors@0.0.0-nightly-20260928023907
-  - @backstage/backend-plugin-api@0.0.0-nightly-20260928023907
-  - @backstage/integration-aws-node@0.0.0-nightly-20260928023907
-  - @backstage/catalog-model@0.0.0-nightly-20260928023907
-  - @backstage/plugin-search-common@0.0.0-nightly-20260928023907
-  - @backstage/plugin-techdocs-common@0.1.1
+  - @backstage/integration@2.1.3
+  - @backstage/backend-plugin-api@1.11.0
+  - @backstage/config@1.3.10
+  - @backstage/errors@1.3.2
+  - @backstage/plugin-techdocs-common@0.1.2
+  - @backstage/catalog-model@1.10.2
+  - @backstage/integration-aws-node@0.2.3
+  - @backstage/plugin-search-common@1.2.26
+
+## 2.0.3-next.2
+
+### Patch Changes
+
+- 76ac6ed: Updated dependency `js-yaml` to `^5.0.0`.
+- Updated dependencies
+  - @backstage/integration@2.1.3-next.1
+  - @backstage/plugin-techdocs-common@0.1.2-next.0
+
+## 2.0.3-next.1
+
+### Patch Changes
+
+- Bumped version to account for a patch release.
+
+## 2.0.2-next.1
+
+### Patch Changes
+
+- 9fc5387: Improved handling of mapping-style Markdown extension configuration.
+- 0fd5fe5: Fixed TechDocs allowing `custom_icons` paths in `mkdocs.yml` that resolve outside the documentation input directory. A `custom_icons` option with such a path is now removed from the configuration with a warning.
+- 8a37336: Fixed TechDocs generation rejecting `mkdocs.yml` files that use the emoji indexes and generators or the `pymdownx.superfences` custom fence formats documented by mkdocs-material, pymdown-extensions and mkdocs-mermaid2.
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.11.0-next.1
 
 ## 2.0.1-next.0
 

package/dist/alpha.cjs.js

@@ -0,0 +1,20 @@
+'use strict';
+
+var DockerContainerRunner = require('./stages/generate/DockerContainerRunner.cjs.js');
+var mkdocsPatchers = require('./stages/generate/mkdocsPatchers.cjs.js');
+var helpers = require('./stages/generate/helpers.cjs.js');
+
+function createDockerContainerRunner() {
+  return new DockerContainerRunner.DockerContainerRunner();
+}
+
+exports.sanitizeMkdocsYml = mkdocsPatchers.sanitizeMkdocsYml;
+exports.MKDOCS_SCHEMA = helpers.MKDOCS_SCHEMA;
+exports.createOrUpdateMetadata = helpers.createOrUpdateMetadata;
+exports.patchIndexPreBuild = helpers.patchIndexPreBuild;
+exports.runCommand = helpers.runCommand;
+exports.storeEtagMetadata = helpers.storeEtagMetadata;
+exports.validateInputDirectory = helpers.validateInputDirectory;
+exports.validateMkdocsYaml = helpers.validateMkdocsYaml;
+exports.createDockerContainerRunner = createDockerContainerRunner;
+//# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2026 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// Building blocks for implementing additional TechDocs generators. These are\n// alpha while the set of engines settles and may change in minor releases.\nimport type { TechDocsContainerRunner } from '@backstage/plugin-techdocs-node';\nimport { DockerContainerRunner } from './stages/generate/DockerContainerRunner';\n\nexport { sanitizeMkdocsYml } from './stages/generate/mkdocsPatchers';\nexport {\n  createOrUpdateMetadata,\n  storeEtagMetadata,\n  runCommand,\n  validateInputDirectory,\n  patchIndexPreBuild,\n  validateMkdocsYaml,\n  MKDOCS_SCHEMA,\n} from './stages/generate/helpers';\nexport type { RunCommandOptions } from './stages/generate/helpers';\n\n/**\n * Creates a container runner that uses the local Docker daemon, the same one\n * the built-in MkDocs generator uses.\n *\n * @alpha\n */\nexport function createDockerContainerRunner(): TechDocsContainerRunner {\n  return new DockerContainerRunner();\n}\n"],"names":["DockerContainerRunner"],"mappings":";;;;;;AAuCO,SAAS,2BAAA,GAAuD;AACrE,EAAA,OAAO,IAAIA,2CAAA,EAAsB;AACnC;;;;;;;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,35 @@
+import { TechDocsContainerRunner } from '@backstage/plugin-techdocs-node';
+import { LoggerService } from '@backstage/backend-plugin-api';
+export { M as MKDOCS_SCHEMA, R as RunCommandOptions, c as createOrUpdateMetadata, p as patchIndexPreBuild, r as runCommand, s as storeEtagMetadata, v as validateInputDirectory, a as validateMkdocsYaml } from './types/helpers.d-DkvPJaTo.js';
+import 'node:child_process';
+import 'js-yaml';
+import 'node:stream';
+
+/**
+ * Sanitize mkdocs.yml by keeping only allowed configuration keys.
+ *
+ * TechDocs only supports a subset of MkDocs configuration options.
+ * This function reconstructs the config with only allowed keys,
+ * discarding everything else. This approach ensures that any unknown
+ * or potentially dangerous configuration options are not passed to MkDocs.
+ *
+ * The file is always rewritten to ensure YAML features like merge keys
+ * and anchors are resolved into plain configuration.
+ *
+ * @param mkdocsYmlPath - Absolute path to mkdocs.yml or equivalent of a docs site
+ * @param logger - A logger instance
+ * @param additionalAllowedKeys - Optional array of additional keys to allow beyond the default allowlist
+ * @param additionalAllowedPlugins - Optional array of additional plugins to allow beyond the default set
+ * @alpha
+ */
+declare const sanitizeMkdocsYml: (mkdocsYmlPath: string, logger: LoggerService, additionalAllowedKeys?: string[], additionalAllowedPlugins?: string[]) => Promise<void>;
+
+/**
+ * Creates a container runner that uses the local Docker daemon, the same one
+ * the built-in MkDocs generator uses.
+ *
+ * @alpha
+ */
+declare function createDockerContainerRunner(): TechDocsContainerRunner;
+
+export { createDockerContainerRunner, sanitizeMkdocsYml };

package/dist/extensions.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { DocsBuildStrategy } from './techdocsTypes';\nimport {\n  PreparerBase,\n  PublisherBase,\n  PublisherType,\n  RemoteProtocol,\n  TechdocsGenerator,\n} from './stages';\nimport * as winston from 'winston';\nimport { PublisherSettings } from './stages/publish/types';\n\n/**\n * Extension point type for configuring TechDocs builds.\n *\n * @public\n */\nexport interface TechdocsBuildsExtensionPoint {\n  setBuildStrategy(buildStrategy: DocsBuildStrategy): void;\n  setBuildLogTransport(transport: winston.transport): void;\n}\n\n/**\n * Extension point for configuring TechDocs builds.\n *\n * @public\n */\nexport const techdocsBuildsExtensionPoint =\n  createExtensionPoint<TechdocsBuildsExtensionPoint>({\n    id: 'techdocs.builds',\n  });\n\n/**\n * Extension point type for configuring a custom TechDocs generator\n *\n * @public\n */\nexport interface TechdocsGeneratorExtensionPoint {\n  setTechdocsGenerator(generator: TechdocsGenerator): void;\n}\n\n/**\n * Extension point for configuring a custom TechDocs generator\n *\n * @public\n */\nexport const techdocsGeneratorExtensionPoint =\n  createExtensionPoint<TechdocsGeneratorExtensionPoint>({\n    id: 'techdocs.generator',\n  });\n\n/**\n * Extension point type for configuring a custom TechDocs preparer\n *\n * @public\n */\nexport interface TechdocsPreparerExtensionPoint {\n  registerPreparer(protocol: RemoteProtocol, preparer: PreparerBase): void;\n}\n\n/**\n * Extension point for configuring a custom TechDocs preparer\n *\n * @public\n */\nexport const techdocsPreparerExtensionPoint =\n  createExtensionPoint<TechdocsPreparerExtensionPoint>({\n    id: 'techdocs.preparer',\n  });\n\n/**\n * Extension point type for configuring a custom TechDocs publisher\n *\n * @public\n */\nexport interface TechdocsPublisherExtensionPoint {\n  registerPublisher(type: PublisherType, publisher: PublisherBase): void;\n  registerPublisherSettings<T extends keyof PublisherSettings>(\n    publisher: T,\n    settings: PublisherSettings[T],\n  ): void;\n}\n\n/**\n * Extension point for configuring a custom TechDocs publisher\n *\n * @public\n */\nexport const techdocsPublisherExtensionPoint =\n  createExtensionPoint<TechdocsPublisherExtensionPoint>({\n    id: 'techdocs.publisher',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AA0CO,MAAM,+BACXA,qCAAA,CAAmD;AAAA,EACjD,EAAA,EAAI;AACN,CAAC;AAgBI,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,EAAA,EAAI;AACN,CAAC;AAgBI,MAAM,iCACXA,qCAAA,CAAqD;AAAA,EACnD,EAAA,EAAI;AACN,CAAC;AAoBI,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,EAAA,EAAI;AACN,CAAC;;;;;"}
+{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { DocsBuildStrategy } from './techdocsTypes';\nimport {\n  GeneratorBase,\n  PreparerBase,\n  PublisherBase,\n  PublisherType,\n  RemoteProtocol,\n  SupportedGeneratorKey,\n} from './stages';\nimport * as winston from 'winston';\nimport { PublisherSettings } from './stages/publish/types';\n\n/**\n * Extension point type for configuring TechDocs builds.\n *\n * @public\n */\nexport interface TechdocsBuildsExtensionPoint {\n  setBuildStrategy(buildStrategy: DocsBuildStrategy): void;\n  setBuildLogTransport(transport: winston.transport): void;\n}\n\n/**\n * Extension point for configuring TechDocs builds.\n *\n * @public\n */\nexport const techdocsBuildsExtensionPoint =\n  createExtensionPoint<TechdocsBuildsExtensionPoint>({\n    id: 'techdocs.builds',\n  });\n\n/**\n * Extension point type for configuring TechDocs generators.\n *\n * Use `registerGenerator` to add an engine-specific generator from a backend\n * module (e.g. `plugin-techdocs-backend-module-zensical`). The key corresponds\n * to the `backstage.io/techdocs-engine` entity annotation value.\n *\n * `setTechdocsGenerator` is kept for backwards compatibility — it replaces the\n * default MkDocs generator.\n *\n * @public\n */\nexport interface TechdocsGeneratorExtensionPoint {\n  setTechdocsGenerator(generator: GeneratorBase): void;\n  registerGenerator(key: SupportedGeneratorKey, generator: GeneratorBase): void;\n}\n\n/**\n * Extension point for configuring a custom TechDocs generator\n *\n * @public\n */\nexport const techdocsGeneratorExtensionPoint =\n  createExtensionPoint<TechdocsGeneratorExtensionPoint>({\n    id: 'techdocs.generator',\n  });\n\n/**\n * Extension point type for configuring a custom TechDocs preparer\n *\n * @public\n */\nexport interface TechdocsPreparerExtensionPoint {\n  registerPreparer(protocol: RemoteProtocol, preparer: PreparerBase): void;\n}\n\n/**\n * Extension point for configuring a custom TechDocs preparer\n *\n * @public\n */\nexport const techdocsPreparerExtensionPoint =\n  createExtensionPoint<TechdocsPreparerExtensionPoint>({\n    id: 'techdocs.preparer',\n  });\n\n/**\n * Extension point type for configuring a custom TechDocs publisher\n *\n * @public\n */\nexport interface TechdocsPublisherExtensionPoint {\n  registerPublisher(type: PublisherType, publisher: PublisherBase): void;\n  registerPublisherSettings<T extends keyof PublisherSettings>(\n    publisher: T,\n    settings: PublisherSettings[T],\n  ): void;\n}\n\n/**\n * Extension point for configuring a custom TechDocs publisher\n *\n * @public\n */\nexport const techdocsPublisherExtensionPoint =\n  createExtensionPoint<TechdocsPublisherExtensionPoint>({\n    id: 'techdocs.publisher',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AA2CO,MAAM,+BACXA,qCAAA,CAAmD;AAAA,EACjD,EAAA,EAAI;AACN,CAAC;AAwBI,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,EAAA,EAAI;AACN,CAAC;AAgBI,MAAM,iCACXA,qCAAA,CAAqD;AAAA,EACnD,EAAA,EAAI;AACN,CAAC;AAoBI,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,EAAA,EAAI;AACN,CAAC;;;;;"}

package/dist/index.cjs.js

@@ -6,6 +6,7 @@ var url = require('./stages/prepare/url.cjs.js');
 var preparers = require('./stages/prepare/preparers.cjs.js');
 var publish = require('./stages/publish/publish.cjs.js');
 var helpers = require('./helpers.cjs.js');
+var techdocsTypes = require('./techdocsTypes.cjs.js');
 var extensions = require('./extensions.cjs.js');
 var generators = require('./stages/generate/generators.cjs.js');
 var techdocs = require('./stages/generate/techdocs.cjs.js');
@@ -22,6 +23,7 @@ exports.getDocFilesFromRepository = helpers.getDocFilesFromRepository;
 exports.getLocationForEntity = helpers.getLocationForEntity;
 exports.parseReferenceAnnotation = helpers.parseReferenceAnnotation;
 exports.transformDirLocation = helpers.transformDirLocation;
+exports.TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY = techdocsTypes.TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY;
 exports.techdocsBuildsExtensionPoint = extensions.techdocsBuildsExtensionPoint;
 exports.techdocsGeneratorExtensionPoint = extensions.techdocsGeneratorExtensionPoint;
 exports.techdocsPreparerExtensionPoint = extensions.techdocsPreparerExtensionPoint;

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -9,6 +9,9 @@ import { IndexableDocument } from '@backstage/plugin-search-common';
 import { Writable } from 'node:stream';
 import * as winston from 'winston';
 import { Logger } from 'winston';
+export { g as getMkdocsYml } from './types/helpers.d-DkvPJaTo.js';
+import 'node:child_process';
+import 'js-yaml';
 
 /**
  * A unique identifier of the tree blob, usually the commit SHA or etag from the target.
@@ -273,6 +276,7 @@ declare class TechdocsGenerator implements GeneratorBase {
  */
 declare class Generators implements GeneratorBuilder {
     private generatorMap;
+    private defaultEngine;
     /**
      * Returns a generators instance containing a generator for TechDocs
      * @param config - A Backstage configuration
@@ -281,7 +285,7 @@ declare class Generators implements GeneratorBuilder {
     static fromConfig(config: Config, options: {
         logger: LoggerService;
         containerRunner?: TechDocsContainerRunner;
-        customGenerator?: TechdocsGenerator;
+        customGenerator?: GeneratorBase;
     }): Promise<GeneratorBuilder>;
     /**
      * Register a generator in the generators collection
@@ -296,24 +300,6 @@ declare class Generators implements GeneratorBuilder {
     get(entity: Entity): GeneratorBase;
 }
 
-/**
- * Finds and loads the contents of an mkdocs.yml, mkdocs.yaml file, a file
- * with a specified name or an ad-hoc created file with minimal config.
- * @public
- *
- * @param inputDir - base dir to be searched for either an mkdocs.yml or mkdocs.yaml file.
- * @param options - name: default mkdocs site_name to be used with a ad hoc file default value is "Documentation Site"
- *                  mkdocsConfigFileName (optional): a non-default file name to be used as the config
- */
-declare const getMkdocsYml: (inputDir: string, options?: {
-    name?: string;
-    mkdocsConfigFileName?: string;
-}) => Promise<{
-    path: string;
-    content: string;
-    configIsTemporary: boolean;
-}>;
-
 /**
  * @public
  * @deprecated
@@ -587,6 +573,12 @@ interface DocsBuildStrategy {
         entity: Entity;
     }): Promise<boolean>;
 }
+/**
+ * A catalog annotation key indicating which TechDoc Generation Engine to use
+ *
+ * @public
+ */
+declare const TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY = "backstage.io/techdocs-engine";
 
 /**
  * Extension point type for configuring TechDocs builds.
@@ -604,12 +596,20 @@ interface TechdocsBuildsExtensionPoint {
  */
 declare const techdocsBuildsExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechdocsBuildsExtensionPoint>;
 /**
- * Extension point type for configuring a custom TechDocs generator
+ * Extension point type for configuring TechDocs generators.
+ *
+ * Use `registerGenerator` to add an engine-specific generator from a backend
+ * module (e.g. `plugin-techdocs-backend-module-zensical`). The key corresponds
+ * to the `backstage.io/techdocs-engine` entity annotation value.
+ *
+ * `setTechdocsGenerator` is kept for backwards compatibility — it replaces the
+ * default MkDocs generator.
  *
  * @public
  */
 interface TechdocsGeneratorExtensionPoint {
-    setTechdocsGenerator(generator: TechdocsGenerator): void;
+    setTechdocsGenerator(generator: GeneratorBase): void;
+    registerGenerator(key: SupportedGeneratorKey, generator: GeneratorBase): void;
 }
 /**
  * Extension point for configuring a custom TechDocs generator
@@ -647,5 +647,5 @@ interface TechdocsPublisherExtensionPoint {
  */
 declare const techdocsPublisherExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<TechdocsPublisherExtensionPoint>;
 
-export { DirectoryPreparer, Generators, Preparers, Publisher, TechdocsGenerator, UrlPreparer, getDocFilesFromRepository, getLocationForEntity, getMkDocsYml, getMkdocsYml, parseReferenceAnnotation, techdocsBuildsExtensionPoint, techdocsGeneratorExtensionPoint, techdocsPreparerExtensionPoint, techdocsPublisherExtensionPoint, transformDirLocation };
+export { DirectoryPreparer, Generators, Preparers, Publisher, TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY, TechdocsGenerator, UrlPreparer, getDocFilesFromRepository, getLocationForEntity, getMkDocsYml, parseReferenceAnnotation, techdocsBuildsExtensionPoint, techdocsGeneratorExtensionPoint, techdocsPreparerExtensionPoint, techdocsPublisherExtensionPoint, transformDirLocation };
 export type { ContainerRunnerPullOptions, DocsBuildStrategy, ETag, GeneratorBase, GeneratorBuilder, GeneratorOptions, GeneratorRunOptions, MigrateRequest, ParsedLocationAnnotation, PreparerBase, PreparerBuilder, PreparerConfig, PreparerOptions, PreparerResponse, PublishRequest, PublishResponse, PublisherBase, PublisherBuilder, PublisherFactory, PublisherSettings, PublisherType, ReadinessResponse, RemoteProtocol, SupportedGeneratorKey, TechDocsContainerRunner, TechDocsDocument, TechDocsMetadata, TechdocsBuildsExtensionPoint, TechdocsGeneratorExtensionPoint, TechdocsPreparerExtensionPoint, TechdocsPublisherExtensionPoint };

package/dist/stages/generate/generators.cjs.js

@@ -1,10 +1,14 @@
 'use strict';
 
-var helpers = require('./helpers.cjs.js');
 var techdocs = require('./techdocs.cjs.js');
+var techdocsTypes = require('../../techdocsTypes.cjs.js');
 
+function normalizeGeneratorKey(key) {
+  return key === "techdocs" ? "mkdocs" : key;
+}
 class Generators {
   generatorMap = /* @__PURE__ */ new Map();
+  defaultEngine = "mkdocs";
   /**
    * Returns a generators instance containing a generator for TechDocs
    * @param config - A Backstage configuration
@@ -12,8 +16,11 @@ class Generators {
    */
   static async fromConfig(config, options) {
     const generators = new Generators();
-    const techdocsGenerator = options.customGenerator ?? techdocs.TechdocsGenerator.fromConfig(config, options);
-    generators.register("techdocs", techdocsGenerator);
+    const defaultEngine = config.getOptionalString("techdocs.generator.defaultEngine") ?? "mkdocs";
+    generators.defaultEngine = defaultEngine;
+    options.logger.info(`TechDocs generator defaultEngine: ${defaultEngine}`);
+    const mkdocsGenerator = options.customGenerator ?? techdocs.TechdocsGenerator.fromConfig(config, options);
+    generators.register("mkdocs", mkdocsGenerator);
     return generators;
   }
   /**
@@ -22,17 +29,26 @@ class Generators {
    * @param generator - The generator instance to register
    */
   register(generatorKey, generator) {
-    this.generatorMap.set(generatorKey, generator);
+    this.generatorMap.set(normalizeGeneratorKey(generatorKey), generator);
   }
   /**
    * Returns the generator for a given TechDocs entity
    * @param entity - A TechDocs entity instance
    */
   get(entity) {
-    const generatorKey = helpers.getGeneratorKey(entity);
+    if (!entity) {
+      throw new Error("No entity provided");
+    }
+    const annotatedEngine = entity.metadata?.annotations?.[techdocsTypes.TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY];
+    const generatorKey = normalizeGeneratorKey(
+      annotatedEngine ?? this.defaultEngine
+    );
     const generator = this.generatorMap.get(generatorKey);
     if (!generator) {
-      throw new Error(`No generator registered for entity: "${generatorKey}"`);
+      const source = annotatedEngine ? `the ${techdocsTypes.TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY} annotation` : "techdocs.generator.defaultEngine";
+      throw new Error(
+        `No TechDocs generator registered for engine "${generatorKey}" (from ${source}). Registered engines: ${[...this.generatorMap.keys()].join(", ")}`
+      );
     }
     return generator;
   }

package/dist/stages/generate/generators.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"generators.cjs.js","sources":["../../../src/stages/generate/generators.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Entity } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { getGeneratorKey } from './helpers';\nimport { TechdocsGenerator } from './techdocs';\nimport {\n  GeneratorBase,\n  GeneratorBuilder,\n  SupportedGeneratorKey,\n} from './types';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { TechDocsContainerRunner } from './types';\n\n/**\n * Collection of docs generators\n * @public\n */\nexport class Generators implements GeneratorBuilder {\n  private generatorMap = new Map<SupportedGeneratorKey, GeneratorBase>();\n\n  /**\n   * Returns a generators instance containing a generator for TechDocs\n   * @param config - A Backstage configuration\n   * @param options - Options to configure the TechDocs generator\n   */\n  static async fromConfig(\n    config: Config,\n    options: {\n      logger: LoggerService;\n      containerRunner?: TechDocsContainerRunner;\n      customGenerator?: TechdocsGenerator;\n    },\n  ): Promise<GeneratorBuilder> {\n    const generators = new Generators();\n\n    const techdocsGenerator =\n      options.customGenerator ?? TechdocsGenerator.fromConfig(config, options);\n    generators.register('techdocs', techdocsGenerator);\n\n    return generators;\n  }\n\n  /**\n   * Register a generator in the generators collection\n   * @param generatorKey - Unique identifier for the generator\n   * @param generator - The generator instance to register\n   */\n  register(generatorKey: SupportedGeneratorKey, generator: GeneratorBase) {\n    this.generatorMap.set(generatorKey, generator);\n  }\n\n  /**\n   * Returns the generator for a given TechDocs entity\n   * @param entity - A TechDocs entity instance\n   */\n  get(entity: Entity): GeneratorBase {\n    const generatorKey = getGeneratorKey(entity);\n    const generator = this.generatorMap.get(generatorKey);\n\n    if (!generator) {\n      throw new Error(`No generator registered for entity: \"${generatorKey}\"`);\n    }\n\n    return generator;\n  }\n}\n"],"names":["TechdocsGenerator","getGeneratorKey"],"mappings":";;;;;AAgCO,MAAM,UAAA,CAAuC;AAAA,EAC1C,YAAA,uBAAmB,GAAA,EAA0C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOrE,aAAa,UAAA,CACX,MAAA,EACA,OAAA,EAK2B;AAC3B,IAAA,MAAM,UAAA,GAAa,IAAI,UAAA,EAAW;AAElC,IAAA,MAAM,oBACJ,OAAA,CAAQ,eAAA,IAAmBA,0BAAA,CAAkB,UAAA,CAAW,QAAQ,OAAO,CAAA;AACzE,IAAA,UAAA,CAAW,QAAA,CAAS,YAAY,iBAAiB,CAAA;AAEjD,IAAA,OAAO,UAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,QAAA,CAAS,cAAqC,SAAA,EAA0B;AACtE,IAAA,IAAA,CAAK,YAAA,CAAa,GAAA,CAAI,YAAA,EAAc,SAAS,CAAA;AAAA,EAC/C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,MAAA,EAA+B;AACjC,IAAA,MAAM,YAAA,GAAeC,wBAAgB,MAAM,CAAA;AAC3C,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,YAAA,CAAa,GAAA,CAAI,YAAY,CAAA;AAEpD,IAAA,IAAI,CAAC,SAAA,EAAW;AACd,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,qCAAA,EAAwC,YAAY,CAAA,CAAA,CAAG,CAAA;AAAA,IACzE;AAEA,IAAA,OAAO,SAAA;AAAA,EACT;AACF;;"}
+{"version":3,"file":"generators.cjs.js","sources":["../../../src/stages/generate/generators.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Entity } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport { TechdocsGenerator } from './techdocs';\nimport {\n  GeneratorBase,\n  GeneratorBuilder,\n  SupportedGeneratorKey,\n} from './types';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { TechDocsContainerRunner } from './types';\nimport { TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY } from '../../techdocsTypes';\n\n/**\n * 'techdocs' was the generator key before engines were introduced, and is\n * kept as an alias of 'mkdocs' so that existing registrations keep working.\n */\nfunction normalizeGeneratorKey(key: SupportedGeneratorKey): string {\n  return key === 'techdocs' ? 'mkdocs' : key;\n}\n\n/**\n * Collection of docs generators\n * @public\n */\nexport class Generators implements GeneratorBuilder {\n  private generatorMap = new Map<SupportedGeneratorKey, GeneratorBase>();\n  private defaultEngine: SupportedGeneratorKey = 'mkdocs';\n\n  /**\n   * Returns a generators instance containing a generator for TechDocs\n   * @param config - A Backstage configuration\n   * @param options - Options to configure the TechDocs generator\n   */\n  static async fromConfig(\n    config: Config,\n    options: {\n      logger: LoggerService;\n      containerRunner?: TechDocsContainerRunner;\n      customGenerator?: GeneratorBase;\n    },\n  ): Promise<GeneratorBuilder> {\n    const generators = new Generators();\n    const defaultEngine =\n      config.getOptionalString('techdocs.generator.defaultEngine') ?? 'mkdocs';\n\n    generators.defaultEngine = defaultEngine;\n\n    options.logger.info(`TechDocs generator defaultEngine: ${defaultEngine}`);\n\n    const mkdocsGenerator =\n      options.customGenerator ?? TechdocsGenerator.fromConfig(config, options);\n    generators.register('mkdocs', mkdocsGenerator);\n\n    return generators;\n  }\n\n  /**\n   * Register a generator in the generators collection\n   * @param generatorKey - Unique identifier for the generator\n   * @param generator - The generator instance to register\n   */\n  register(generatorKey: SupportedGeneratorKey, generator: GeneratorBase) {\n    this.generatorMap.set(normalizeGeneratorKey(generatorKey), generator);\n  }\n\n  /**\n   * Returns the generator for a given TechDocs entity\n   * @param entity - A TechDocs entity instance\n   */\n  get(entity: Entity): GeneratorBase {\n    if (!entity) {\n      throw new Error('No entity provided');\n    }\n\n    const annotatedEngine =\n      entity.metadata?.annotations?.[TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY];\n    const generatorKey = normalizeGeneratorKey(\n      annotatedEngine ?? this.defaultEngine,\n    );\n    const generator = this.generatorMap.get(generatorKey);\n\n    if (!generator) {\n      const source = annotatedEngine\n        ? `the ${TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY} annotation`\n        : 'techdocs.generator.defaultEngine';\n      throw new Error(\n        `No TechDocs generator registered for engine \"${generatorKey}\" (from ${source}). ` +\n          `Registered engines: ${[...this.generatorMap.keys()].join(', ')}`,\n      );\n    }\n\n    return generator;\n  }\n}\n"],"names":["TechdocsGenerator","TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY"],"mappings":";;;;;AAgCA,SAAS,sBAAsB,GAAA,EAAoC;AACjE,EAAA,OAAO,GAAA,KAAQ,aAAa,QAAA,GAAW,GAAA;AACzC;AAMO,MAAM,UAAA,CAAuC;AAAA,EAC1C,YAAA,uBAAmB,GAAA,EAA0C;AAAA,EAC7D,aAAA,GAAuC,QAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO/C,aAAa,UAAA,CACX,MAAA,EACA,OAAA,EAK2B;AAC3B,IAAA,MAAM,UAAA,GAAa,IAAI,UAAA,EAAW;AAClC,IAAA,MAAM,aAAA,GACJ,MAAA,CAAO,iBAAA,CAAkB,kCAAkC,CAAA,IAAK,QAAA;AAElE,IAAA,UAAA,CAAW,aAAA,GAAgB,aAAA;AAE3B,IAAA,OAAA,CAAQ,MAAA,CAAO,IAAA,CAAK,CAAA,kCAAA,EAAqC,aAAa,CAAA,CAAE,CAAA;AAExE,IAAA,MAAM,kBACJ,OAAA,CAAQ,eAAA,IAAmBA,0BAAA,CAAkB,UAAA,CAAW,QAAQ,OAAO,CAAA;AACzE,IAAA,UAAA,CAAW,QAAA,CAAS,UAAU,eAAe,CAAA;AAE7C,IAAA,OAAO,UAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,QAAA,CAAS,cAAqC,SAAA,EAA0B;AACtE,IAAA,IAAA,CAAK,YAAA,CAAa,GAAA,CAAI,qBAAA,CAAsB,YAAY,GAAG,SAAS,CAAA;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,MAAA,EAA+B;AACjC,IAAA,IAAI,CAAC,MAAA,EAAQ;AACX,MAAA,MAAM,IAAI,MAAM,oBAAoB,CAAA;AAAA,IACtC;AAEA,IAAA,MAAM,eAAA,GACJ,MAAA,CAAO,QAAA,EAAU,WAAA,GAAcC,oDAAsC,CAAA;AACvE,IAAA,MAAM,YAAA,GAAe,qBAAA;AAAA,MACnB,mBAAmB,IAAA,CAAK;AAAA,KAC1B;AACA,IAAA,MAAM,SAAA,GAAY,IAAA,CAAK,YAAA,CAAa,GAAA,CAAI,YAAY,CAAA;AAEpD,IAAA,IAAI,CAAC,SAAA,EAAW;AACd,MAAA,MAAM,MAAA,GAAS,eAAA,GACX,CAAA,IAAA,EAAOA,oDAAsC,CAAA,WAAA,CAAA,GAC7C,kCAAA;AACJ,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,6CAAA,EAAgD,YAAY,CAAA,QAAA,EAAW,MAAM,0BACpD,CAAC,GAAG,IAAA,CAAK,YAAA,CAAa,IAAA,EAAM,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,OACnE;AAAA,IACF;AAEA,IAAA,OAAO,SAAA;AAAA,EACT;AACF;;"}

package/dist/stages/generate/helpers.cjs.js

@@ -12,17 +12,29 @@ var helpers = require('../publish/helpers.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 var gitUrlParse__default = /*#__PURE__*/_interopDefaultCompat(gitUrlParse);
-var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+var yaml__namespace = /*#__PURE__*/_interopNamespaceCompat(yaml);
 var path__default = /*#__PURE__*/_interopDefaultCompat(path);
 
-function getGeneratorKey(entity) {
-  if (!entity) {
-    throw new Error("No entity provided");
-  }
-  return "techdocs";
-}
 const runCommand = async ({
   command,
   args,
@@ -72,8 +84,28 @@ const getRepoUrlFromLocationAnnotation = (parsedLocationAnnotation, scmIntegrati
   return {};
 };
 const ALLOWED_PYTHON_YAML_TAGS = /* @__PURE__ */ new Set([
+  // Emoji indexes; mkdocs-material moved its own from materialx to
+  // material.extensions in 9.4.
+  "tag:yaml.org,2002:python/name:pymdownx.emoji.emojione",
+  "tag:yaml.org,2002:python/name:pymdownx.emoji.gemoji",
+  "tag:yaml.org,2002:python/name:pymdownx.emoji.twemoji",
   "tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
-  "tag:yaml.org,2002:python/object.apply:materialx.emoji.to_svg",
+  "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+  // Emoji generators
+  "tag:yaml.org,2002:python/name:pymdownx.emoji.to_alt",
+  "tag:yaml.org,2002:python/name:pymdownx.emoji.to_png",
+  "tag:yaml.org,2002:python/name:pymdownx.emoji.to_png_sprite",
+  "tag:yaml.org,2002:python/name:pymdownx.emoji.to_svg",
+  "tag:yaml.org,2002:python/name:pymdownx.emoji.to_svg_sprite",
+  "tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
+  "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+  // Custom fence formats, used for Mermaid diagrams. The mermaid2 ones come
+  // from mkdocs-mermaid2, which mkdocs-techdocs-core does not bundle.
+  "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
+  "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_div_format",
+  "tag:yaml.org,2002:python/name:mermaid2.fence_mermaid",
+  "tag:yaml.org,2002:python/name:mermaid2.fence_mermaid_custom",
+  // Slug factory for toc and pymdownx.tabbed
   "tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify"
 ]);
 class UnknownTag {
@@ -87,32 +119,36 @@ class UnknownTag {
     this.type = type;
   }
 }
-const MKDOCS_SCHEMA = yaml.DEFAULT_SCHEMA.extend([
-  new yaml.Type("", {
-    kind: "scalar",
-    multi: true,
-    representName: (o) => o.type,
-    represent: (o) => o.data ?? "",
-    instanceOf: UnknownTag,
-    construct: (data, type) => new UnknownTag(data, type)
+const MKDOCS_SCHEMA = yaml.YAML11_SCHEMA.withTags(
+  yaml.defineScalarTag("", {
+    matchByTagPrefix: true,
+    resolve: (data, _isExplicit, tagName) => new UnknownTag(data, tagName),
+    identify: (data) => data instanceof UnknownTag && typeof data.data === "string",
+    represent: (data) => data.data,
+    representTagName: (data) => data.type
   }),
-  new yaml.Type("tag:", {
-    kind: "mapping",
-    multi: true,
-    representName: (o) => o.type,
-    represent: (o) => o.data ?? "",
-    instanceOf: UnknownTag,
-    construct: (data, type) => new UnknownTag(data, type)
+  yaml.defineSequenceTag("", {
+    matchByTagPrefix: true,
+    create: (tagName) => new UnknownTag([], tagName),
+    addItem: (carrier, item) => {
+      carrier.data.push(item);
+    },
+    identify: (data) => data instanceof UnknownTag && Array.isArray(data.data),
+    represent: (data) => data.data,
+    representTagName: (data) => data.type
   }),
-  new yaml.Type("", {
-    kind: "sequence",
-    multi: true,
-    representName: (o) => o.type,
-    represent: (o) => o.data ?? "",
-    instanceOf: UnknownTag,
-    construct: (data, type) => new UnknownTag(data, type)
+  yaml.defineMappingTag("tag:", {
+    matchByTagPrefix: true,
+    create: (tagName) => new UnknownTag({}, tagName),
+    addPair: (carrier, key, value) => yaml.mapTag.addPair(carrier.data, key, value),
+    has: (carrier, key) => yaml.mapTag.has(carrier.data, key),
+    keys: (result) => yaml.mapTag.keys(result.data),
+    get: (result, key) => yaml.mapTag.get(result.data, key),
+    identify: (data) => data instanceof UnknownTag && typeof data.data === "object" && data.data !== null && !Array.isArray(data.data),
+    represent: (data) => new Map(Object.entries(data.data)),
+    representTagName: (data) => data.type
   })
-]);
+);
 const generateMkdocsYml = async (inputDir, siteOptions) => {
   try {
     const mkdocsYmlPath = path__default.default.join(inputDir, "mkdocs.yml");
@@ -124,7 +160,7 @@ const generateMkdocsYml = async (inputDir, siteOptions) => {
     };
     await fs__default.default.writeFile(
       mkdocsYmlPath,
-      yaml__default.default.dump(defaultMkdocsContent, { schema: MKDOCS_SCHEMA })
+      yaml__namespace.dump(defaultMkdocsContent, { schema: MKDOCS_SCHEMA })
     );
   } catch (error) {
     throw new errors.ForwardedError("Could not generate mkdocs.yml file", error);
@@ -228,7 +264,7 @@ const ALLOWED_THEME_KEYS = /* @__PURE__ */ new Set([
   "features"
 ]);
 const validateMkdocsYaml = async (inputDir, mkdocsYmlFileString) => {
-  const mkdocsYml = yaml__default.default.load(mkdocsYmlFileString, {
+  const mkdocsYml = yaml__namespace.load(mkdocsYmlFileString, {
     schema: MKDOCS_SCHEMA
   });
   if (mkdocsYml === null || typeof mkdocsYml !== "object") {
@@ -303,7 +339,7 @@ const patchIndexPreBuild = async ({
     ].join(" ")} exists.`
   );
 };
-const createOrUpdateMetadata = async (techdocsMetadataPath, logger) => {
+const createOrUpdateMetadata = async (techdocsMetadataPath, logger, engine) => {
   const techdocsMetadataDir = techdocsMetadataPath.split(path__default.default.sep).slice(0, -1).join(path__default.default.sep);
   try {
     await fs__default.default.access(techdocsMetadataPath, fs__default.default.constants.F_OK);
@@ -319,6 +355,9 @@ const createOrUpdateMetadata = async (techdocsMetadataPath, logger) => {
     throw new Error(message);
   }
   json.build_timestamp = Date.now();
+  if (engine) {
+    json.engine = engine;
+  }
   try {
     json.files = (await helpers.getFileTreeRecursively(techdocsMetadataDir)).map(
       (file) => file.replace(`${techdocsMetadataDir}${path__default.default.sep}`, "")
@@ -345,7 +384,6 @@ exports.MKDOCS_SCHEMA = MKDOCS_SCHEMA;
 exports.UnknownTag = UnknownTag;
 exports.createOrUpdateMetadata = createOrUpdateMetadata;
 exports.generateMkdocsYml = generateMkdocsYml;
-exports.getGeneratorKey = getGeneratorKey;
 exports.getMkdocsYml = getMkdocsYml;
 exports.getRepoUrlFromLocationAnnotation = getRepoUrlFromLocationAnnotation;
 exports.patchIndexPreBuild = patchIndexPreBuild;