@backstage/plugin-techdocs-backend 2.4.0 → 2.4.1-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/config.schema.json +4 -4
  3. package/package.json +14 -14
package/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # @backstage/plugin-techdocs-backend
2
2
 
3
+ ## 2.4.1-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - 4d7a3fe: Clarified in the config schema which `techdocs.generator.mkdocs` settings also apply to the Zensical engine: `legacyCopyReadmeMdToIndexMd`, `dangerouslyAllowAdditionalKeys` and `dangerouslyAllowAdditionalPlugins`.
8
+ - Updated dependencies
9
+ - @backstage/plugin-techdocs-node@2.2.0-next.0
10
+ - @backstage/backend-plugin-api@1.11.1-next.0
11
+ - @backstage/plugin-catalog-node@2.2.7-next.0
12
+
3
13
  ## 2.4.0
4
14
 
5
15
  ### Minor Changes
package/config.schema.json CHANGED
@@ -71,7 +71,7 @@
71
71
  "properties": {
72
72
  "legacyCopyReadmeMdToIndexMd": {
73
73
  "type": "boolean",
74
- "description": "(Optional and not recommended) Configures the techdocs generator to attempt to ensure an index.md exists falling back to using <docs-dir>/README.md or README.md in case a default <docs-dir>/index.md is not provided. Note that https://www.mkdocs.org/user-guide/configuration/#edit_uri behavior will be broken in these scenarios."
74
+ "description": "(Optional and not recommended) Configures the techdocs generator to attempt to ensure an index.md exists falling back to using <docs-dir>/README.md or README.md in case a default <docs-dir>/index.md is not provided. Note that https://www.mkdocs.org/user-guide/configuration/#edit_uri behavior will be broken in these scenarios.\n\nAlso applies to the Zensical engine."
75
75
  },
76
76
  "defaultPlugins": {
77
77
  "type": "array",
@@ -85,21 +85,21 @@
85
85
  "items": {
86
86
  "type": "string"
87
87
  },
88
- "description": "List of additional MkDocs configuration keys to allow beyond the default safe allowlist. This can introduce security vulnerabilities.\n\nWARNING: Some MkDocs configuration keys can execute arbitrary code. For example, the 'hooks' key allows running arbitrary Python code during documentation generation. Only use this in trusted environments where all mkdocs.yml files are audited."
88
+ "description": "List of additional MkDocs configuration keys to allow beyond the default safe allowlist. This can introduce security vulnerabilities.\n\nWARNING: Some MkDocs configuration keys can execute arbitrary code. For example, the 'hooks' key allows running arbitrary Python code during documentation generation. Only use this in trusted environments where all mkdocs.yml files are audited.\n\nAlso applies to the Zensical engine, which reads the same mkdocs.yml, so this configuration will affect both."
89
89
  },
90
90
  "dangerouslyAllowAdditionalPlugins": {
91
91
  "type": "array",
92
92
  "items": {
93
93
  "type": "string"
94
94
  },
95
- "description": "List of additional MkDocs plugins to allow beyond the default set. Plugins not in this list or the default set will be removed from mkdocs.yml before documentation generation.\n\nWARNING: Some MkDocs plugins can make outbound HTTP requests or execute arbitrary code during documentation generation. Only allow plugins that have been audited for use in your environment, including the configuration options that documentation authors can supply."
95
+ "description": "List of additional MkDocs plugins to allow beyond the default set. Plugins not in this list or the default set will be removed from mkdocs.yml before documentation generation.\n\nWARNING: Some MkDocs plugins can make outbound HTTP requests or execute arbitrary code during documentation generation. Only allow plugins that have been audited for use in your environment, including the configuration options that documentation authors can supply.\n\nAlso applies to the Zensical engine, which reads the same mkdocs.yml, so this configuration will affect both."
96
96
  },
97
97
  "disableExternalFonts": {
98
98
  "type": "boolean",
99
99
  "description": "Disable external fonts for all TechDocs sites. If not set, the default value is false. If set to true, the external font will be disabled for all TechDocs sites. If set to false, the external font will be enabled for all TechDocs sites."
100
100
  }
101
101
  },
102
- "description": "Override behavior specific to mkdocs."
102
+ "description": "Override behavior for mkdocs.yml-based builds. Unless noted otherwise, these settings apply to the MkDocs engine only."
103
103
  }
104
104
  },
105
105
  "required": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-techdocs-backend",
3
- "version": "2.4.0",
3
+ "version": "2.4.1-next.0",
4
4
  "description": "The Backstage backend plugin that renders technical documentation for your components",
5
5
  "backstage": {
6
6
  "role": "backend-plugin",
@@ -75,16 +75,16 @@
75
75
  "test": "backstage-cli package test"
76
76
  },
77
77
  "dependencies": {
78
- "@backstage/backend-plugin-api": "^1.11.0",
79
- "@backstage/catalog-client": "^1.16.3",
80
- "@backstage/catalog-model": "^1.10.2",
81
- "@backstage/config": "^1.3.10",
82
- "@backstage/errors": "^1.3.2",
83
- "@backstage/integration": "^2.1.3",
84
- "@backstage/plugin-catalog-node": "^2.2.6",
85
- "@backstage/plugin-techdocs-common": "^0.1.2",
86
- "@backstage/plugin-techdocs-node": "^2.1.0",
87
- "@backstage/types": "^1.2.2",
78
+ "@backstage/backend-plugin-api": "1.11.1-next.0",
79
+ "@backstage/catalog-client": "1.16.3",
80
+ "@backstage/catalog-model": "1.10.2",
81
+ "@backstage/config": "1.3.10",
82
+ "@backstage/errors": "1.3.2",
83
+ "@backstage/integration": "2.1.3",
84
+ "@backstage/plugin-catalog-node": "2.2.7-next.0",
85
+ "@backstage/plugin-techdocs-common": "0.1.2",
86
+ "@backstage/plugin-techdocs-node": "2.2.0-next.0",
87
+ "@backstage/types": "1.2.2",
88
88
  "express": "^4.22.0",
89
89
  "express-promise-router": "^4.1.0",
90
90
  "fs-extra": "^11.2.0",
@@ -93,9 +93,9 @@
93
93
  "winston": "^3.2.1"
94
94
  },
95
95
  "devDependencies": {
96
- "@backstage/backend-defaults": "^0.18.1",
97
- "@backstage/backend-test-utils": "^1.11.8",
98
- "@backstage/cli": "^0.36.7",
96
+ "@backstage/backend-defaults": "0.18.2-next.0",
97
+ "@backstage/backend-test-utils": "1.11.9-next.0",
98
+ "@backstage/cli": "0.36.8-next.0",
99
99
  "@types/compression": "^1.7.5",
100
100
  "@types/express": "^4.17.6",
101
101
  "compression": "^1.7.4",