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:rawandgeneratevia--engine zensical(or thebackstage.io/techdocs-engineannotation incatalog-info.yaml), including live reload in the preview app. The default--docker-imageis now chosen per engine instead of always beingspotify/techdocs, and matches the image the TechDocs backend uses for that engine, so MkDocs previews now usespotify/techdocs:v1.2.8instead oflatest. Passing--docker-imageexplicitly behaves as before.The
serveflags--mkdocs-port,--mkdocs-config-file-nameand--mkdocs-parameter-*are deprecated in favor of--engine-port,--config-file-nameand--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: zensicalannotation, or settechdocs.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/alphaentry point with building blocks for implementing additional documentation engines in separate modules:createDockerContainerRunner,createOrUpdateMetadata,storeEtagMetadata,runCommand,validateInputDirectory,patchIndexPreBuild, and themkdocs.ymlhelpersMKDOCS_SCHEMA,validateMkdocsYamlandsanitizeMkdocsYml. 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.mkdocssettings also apply to the Zensical engine:legacyCopyReadmeMdToIndexMd,dangerouslyAllowAdditionalKeysanddangerouslyAllowAdditionalPlugins. - 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