Skip to main content

Release v1.56.3

Upgrade Helper: https://backstage.github.io/upgrade-helper/?to=1.56.3

@techdocs/cli@1.14.0​

Minor Changes​

  • 8fd70e3: Add Zensical support to serve, serve:raw and generate via --engine zensical (or the backstage.io/techdocs-engine annotation in catalog-info.yaml), including live reload in the preview app. The default --docker-image is now chosen per engine instead of always being spotify/techdocs, and matches the image the TechDocs backend uses for that engine, so MkDocs previews now use spotify/techdocs:v1.2.8 instead of latest. Passing --docker-image explicitly behaves as before.

    The serve flags --mkdocs-port, --mkdocs-config-file-name and --mkdocs-parameter-* are deprecated in favor of --engine-port, --config-file-name and --parameter-*. If both the old and new flag are given, the new one wins and the warning says the old one is ignored.

Patch Changes​

  • Updated dependencies
    • @backstage/plugin-techdocs-node@2.2.0

@backstage/plugin-techdocs-backend-module-zensical@0.1.0​

Minor Changes​

  • 8fd70e3: New module that adds Zensical as an experimental TechDocs documentation engine. Opt entities in with the backstage.io/techdocs-engine: zensical annotation, or set techdocs.generator.defaultEngine: zensical. See Zensical Engine for setup and configuration.

Patch Changes​

  • Updated dependencies
    • @backstage/plugin-techdocs-node@2.2.0

@backstage/plugin-techdocs-node@2.2.0​

Minor Changes​

  • 8fd70e3: 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.

@backstage/plugin-techdocs-backend@2.4.1​

Patch Changes​

  • 8fd70e3: Clarified in the config schema which techdocs.generator.mkdocs settings also apply to the Zensical engine: legacyCopyReadmeMdToIndexMd, dangerouslyAllowAdditionalKeys and dangerouslyAllowAdditionalPlugins.
  • Updated dependencies
    • @backstage/plugin-techdocs-node@2.2.0

example-backend@0.0.56​

Patch Changes​

  • Updated dependencies
    • @backstage/plugin-techdocs-backend@2.4.1
    • @backstage/plugin-techdocs-backend-module-zensical@0.1.0