@backstage/plugin-techdocs 1.17.4 → 1.17.5
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.
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs
|
|
2
2
|
|
|
3
|
+
## 1.17.5
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 59c1e54: Made the TechDocs sidebar positioning at tablet breakpoints configurable via CSS custom properties, allowing apps with custom sidebar widths to override the defaults. The available properties are `--techdocs-sidebar-closed-offset-pinned`, `--techdocs-sidebar-closed-offset-collapsed`, and `--techdocs-sidebar-open-translate`.
|
|
8
|
+
- bc41a91: The `zod` dependency has been bumped from `^3.25.76 || ^4.0.0` to `^4.0.0`, since `configSchema` requires the full Zod v4 package for JSON Schema support.
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
- @backstage/ui@0.14.2
|
|
11
|
+
- @backstage/frontend-plugin-api@0.16.2
|
|
12
|
+
- @backstage/plugin-catalog-react@2.1.4
|
|
13
|
+
- @backstage/plugin-search-react@1.11.3
|
|
14
|
+
|
|
3
15
|
## 1.17.4
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
var name = "@backstage/plugin-techdocs";
|
|
2
|
-
var version = "1.17.
|
|
2
|
+
var version = "1.17.5";
|
|
3
3
|
var description = "The Backstage plugin that renders technical documentation for your components";
|
|
4
4
|
var backstage = {
|
|
5
5
|
role: "frontend-plugin",
|
|
@@ -86,7 +86,7 @@ var dependencies = {
|
|
|
86
86
|
lodash: "^4.17.21",
|
|
87
87
|
"react-helmet": "6.1.0",
|
|
88
88
|
"react-use": "^17.2.4",
|
|
89
|
-
zod: "^
|
|
89
|
+
zod: "^4.0.0"
|
|
90
90
|
};
|
|
91
91
|
var devDependencies = {
|
|
92
92
|
"@backstage/cli": "workspace:^",
|
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
const
|
|
1
|
+
const TECHDOCS_SIDEBAR_WIDTH = "16rem";
|
|
2
|
+
const APP_SIDEBAR_WIDTH_PINNED = "224px";
|
|
3
|
+
const APP_SIDEBAR_WIDTH_COLLAPSED = "72px";
|
|
2
4
|
var layout = ({ theme, sidebar }) => `
|
|
3
5
|
|
|
4
6
|
/*================== Layout ==================*/
|
|
@@ -61,10 +63,10 @@ var layout = ({ theme, sidebar }) => `
|
|
|
61
63
|
.md-sidebar {
|
|
62
64
|
bottom: 75px;
|
|
63
65
|
position: fixed;
|
|
64
|
-
width:
|
|
66
|
+
width: ${TECHDOCS_SIDEBAR_WIDTH};
|
|
65
67
|
}
|
|
66
68
|
.md-sidebar .md-sidebar__scrollwrap {
|
|
67
|
-
width: calc(
|
|
69
|
+
width: calc(${TECHDOCS_SIDEBAR_WIDTH});
|
|
68
70
|
height: 100%
|
|
69
71
|
}
|
|
70
72
|
|
|
@@ -78,13 +80,13 @@ var layout = ({ theme, sidebar }) => `
|
|
|
78
80
|
}
|
|
79
81
|
|
|
80
82
|
.md-content {
|
|
81
|
-
max-width: calc(100% -
|
|
82
|
-
margin-left:
|
|
83
|
+
max-width: calc(100% - ${TECHDOCS_SIDEBAR_WIDTH} * 2);
|
|
84
|
+
margin-left: ${TECHDOCS_SIDEBAR_WIDTH};
|
|
83
85
|
margin-bottom: 50px;
|
|
84
86
|
}
|
|
85
87
|
|
|
86
88
|
.md-content > .md-sidebar {
|
|
87
|
-
left:
|
|
89
|
+
left: ${TECHDOCS_SIDEBAR_WIDTH};
|
|
88
90
|
}
|
|
89
91
|
|
|
90
92
|
.md-footer {
|
|
@@ -101,7 +103,7 @@ var layout = ({ theme, sidebar }) => `
|
|
|
101
103
|
background-color: unset;
|
|
102
104
|
}
|
|
103
105
|
.md-footer-nav__link, .md-footer__link {
|
|
104
|
-
width:
|
|
106
|
+
width: ${TECHDOCS_SIDEBAR_WIDTH};
|
|
105
107
|
}
|
|
106
108
|
|
|
107
109
|
.md-dialog {
|
|
@@ -166,16 +168,16 @@ var layout = ({ theme, sidebar }) => `
|
|
|
166
168
|
height: 100%;
|
|
167
169
|
}
|
|
168
170
|
.md-sidebar--primary {
|
|
169
|
-
width:
|
|
171
|
+
width: ${TECHDOCS_SIDEBAR_WIDTH} !important;
|
|
170
172
|
z-index: 200;
|
|
171
|
-
left: ${sidebar.isPinned ? `calc(
|
|
173
|
+
left: ${sidebar.isPinned ? `calc(-${TECHDOCS_SIDEBAR_WIDTH} + var(--techdocs-sidebar-closed-offset-pinned, ${APP_SIDEBAR_WIDTH_PINNED}))` : `calc(-${TECHDOCS_SIDEBAR_WIDTH} + var(--techdocs-sidebar-closed-offset-collapsed, ${APP_SIDEBAR_WIDTH_COLLAPSED}))`} !important;
|
|
172
174
|
}
|
|
173
175
|
.md-sidebar--secondary:not([hidden]) {
|
|
174
176
|
display: none;
|
|
175
177
|
}
|
|
176
178
|
|
|
177
179
|
[data-md-toggle=drawer]:checked~.md-container .md-sidebar--primary {
|
|
178
|
-
transform: translateX(
|
|
180
|
+
transform: translateX(var(--techdocs-sidebar-open-translate, ${TECHDOCS_SIDEBAR_WIDTH}));
|
|
179
181
|
}
|
|
180
182
|
|
|
181
183
|
.md-content {
|
|
@@ -205,8 +207,8 @@ var layout = ({ theme, sidebar }) => `
|
|
|
205
207
|
|
|
206
208
|
@media screen and (max-width: 600px) {
|
|
207
209
|
.md-sidebar--primary {
|
|
208
|
-
left:
|
|
209
|
-
width:
|
|
210
|
+
left: -${TECHDOCS_SIDEBAR_WIDTH} !important;
|
|
211
|
+
width: ${TECHDOCS_SIDEBAR_WIDTH};
|
|
210
212
|
}
|
|
211
213
|
}
|
|
212
214
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"layout.esm.js","sources":["../../../../../src/reader/transformers/styles/rules/layout.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { RuleOptions } from './types';\n\nconst
|
|
1
|
+
{"version":3,"file":"layout.esm.js","sources":["../../../../../src/reader/transformers/styles/rules/layout.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { RuleOptions } from './types';\n\nconst TECHDOCS_SIDEBAR_WIDTH = '16rem';\nconst APP_SIDEBAR_WIDTH_PINNED = '224px';\nconst APP_SIDEBAR_WIDTH_COLLAPSED = '72px';\n\nexport default ({ theme, sidebar }: RuleOptions) => `\n\n/*================== Layout ==================*/\n\n/* mkdocs material v9 compat */\n.md-nav__title {\n color: var(--md-default-fg-color);\n}\n\n.md-grid {\n max-width: 100%;\n margin: 0;\n}\n\n.md-nav {\n font-size: calc(var(--md-typeset-font-size) * 0.9);\n}\n.md-nav__link:not(:has(svg)) {\n display: flex;\n align-items: center;\n justify-content: space-between;\n}\n.md-nav__link:has(svg) > .md-ellipsis {\n flex-grow: 1;\n}\n.md-nav__icon {\n height: 20px !important;\n width: 20px !important;\n margin-left:${theme.spacing(1)}px;\n}\n.md-nav__icon svg {\n margin: 0;\n width: 20px !important;\n height: 20px !important;\n}\n.md-nav__icon:after {\n width: 20px !important;\n height: 20px !important;\n}\n.md-status--updated::after {\n -webkit-mask-image: var(--md-status--updated);\n mask-image: var(--md-status--updated);\n}\n\n.md-nav__item--active > .md-nav__link, a.md-nav__link--active {\n text-decoration: underline;\n color: var(--md-typeset-a-color);\n}\n.md-nav__link--active > .md-status:after {\n background-color: var(--md-typeset-a-color);\n}\n.md-nav__link[href]:hover > .md-status:after {\n background-color: var(--md-accent-fg-color);\n}\n\n.md-main__inner {\n margin-top: 0;\n}\n\n.md-sidebar {\n bottom: 75px;\n position: fixed;\n width: ${TECHDOCS_SIDEBAR_WIDTH};\n}\n.md-sidebar .md-sidebar__scrollwrap {\n width: calc(${TECHDOCS_SIDEBAR_WIDTH});\n height: 100%\n}\n\n@supports selector(::-webkit-scrollbar) {\n [dir=ltr] .md-sidebar__inner {\n padding-right: calc(100% - 15.1rem);\n }\n}\n.md-sidebar--secondary {\n right: ${theme.spacing(3)}px;\n}\n\n.md-content {\n max-width: calc(100% - ${TECHDOCS_SIDEBAR_WIDTH} * 2);\n margin-left: ${TECHDOCS_SIDEBAR_WIDTH};\n margin-bottom: 50px;\n}\n\n.md-content > .md-sidebar {\n left: ${TECHDOCS_SIDEBAR_WIDTH};\n}\n\n.md-footer {\n position: fixed;\n bottom: 0px;\n pointer-events: none;\n}\n\n.md-footer-nav__link, .md-footer__link {\n pointer-events: all;\n}\n\n.md-footer__title {\n background-color: unset;\n}\n.md-footer-nav__link, .md-footer__link {\n width: ${TECHDOCS_SIDEBAR_WIDTH};\n}\n\n.md-dialog {\n background-color: unset;\n}\n\n@media screen and (min-width: 76.25em) {\n .md-sidebar {\n height: auto;\n /* Less padding before the Previous / Next buttons */\n padding-bottom: 0 !important;\n }\n}\n\n@media screen and (max-width: 76.1875em) {\n .md-nav {\n transition: none !important;\n background-color: var(--md-default-bg-color)\n }\n .md-nav--primary .md-nav__title {\n cursor: auto;\n color: var(--md-default-fg-color);\n font-weight: 700;\n white-space: normal;\n line-height: 1rem;\n height: auto;\n display: flex;\n flex-flow: column;\n row-gap: 1.6rem;\n padding: 1.2rem .8rem .8rem;\n background-color: var(--md-default-bg-color);\n }\n .md-nav--primary .md-nav__title~.md-nav__list {\n box-shadow: none;\n }\n .md-nav--primary .md-nav__title ~ .md-nav__list > :first-child {\n border-top: none;\n }\n .md-nav--primary .md-nav__title .md-nav__button {\n display: none;\n }\n .md-nav--primary .md-nav__title .md-nav__icon {\n color: var(--md-default-fg-color);\n position: static;\n height: auto;\n margin: 0 0 0 -0.2rem;\n }\n .md-nav--primary > .md-nav__title [for=\"none\"] {\n padding-top: 0;\n }\n .md-nav--primary .md-nav__item {\n border-top: none;\n }\n .md-nav--primary :is(.md-nav__title,.md-nav__item) {\n font-size : var(--md-typeset-font-size);\n }\n .md-nav .md-source {\n display: none;\n }\n\n .md-sidebar {\n height: 100%;\n }\n .md-sidebar--primary {\n width: ${TECHDOCS_SIDEBAR_WIDTH} !important;\n z-index: 200;\n left: ${\n sidebar.isPinned\n ? `calc(-${TECHDOCS_SIDEBAR_WIDTH} + var(--techdocs-sidebar-closed-offset-pinned, ${APP_SIDEBAR_WIDTH_PINNED}))`\n : `calc(-${TECHDOCS_SIDEBAR_WIDTH} + var(--techdocs-sidebar-closed-offset-collapsed, ${APP_SIDEBAR_WIDTH_COLLAPSED}))`\n } !important;\n }\n .md-sidebar--secondary:not([hidden]) {\n display: none;\n }\n\n [data-md-toggle=drawer]:checked~.md-container .md-sidebar--primary {\n transform: translateX(var(--techdocs-sidebar-open-translate, ${TECHDOCS_SIDEBAR_WIDTH}));\n }\n\n .md-content {\n max-width: 100%;\n margin-left: 0;\n }\n\n .md-header__button {\n margin: 0.4rem 0;\n margin-left: 0.4rem;\n padding: 0;\n }\n\n .md-overlay {\n left: 0;\n }\n\n .md-footer {\n position: static;\n padding-left: 0;\n }\n .md-footer-nav__link {\n /* footer links begin to overlap at small sizes without setting width */\n width: 50%;\n }\n}\n\n@media screen and (max-width: 600px) {\n .md-sidebar--primary {\n left: -${TECHDOCS_SIDEBAR_WIDTH} !important;\n width: ${TECHDOCS_SIDEBAR_WIDTH};\n }\n}\n\n\n@media print {\n .md-sidebar,\n #toggle-sidebar {\n display: none;\n }\n\n .md-content {\n margin: 0;\n width: 100%;\n max-width: 100%;\n }\n}\n`;\n"],"names":[],"mappings":"AAkBA,MAAM,sBAAA,GAAyB,OAAA;AAC/B,MAAM,wBAAA,GAA2B,OAAA;AACjC,MAAM,2BAAA,GAA8B,MAAA;AAEpC,aAAe,CAAC,EAAE,KAAA,EAAO,OAAA,EAAQ,KAAmB;;AAAA;;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,cAAA,EA4BpC,KAAA,CAAM,OAAA,CAAQ,CAAC,CAAC,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA,SAAA,EAkCrB,sBAAsB,CAAA;AAAA;AAAA;AAAA,cAAA,EAGjB,sBAAsB,CAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,SAAA,EAU3B,KAAA,CAAM,OAAA,CAAQ,CAAC,CAAC,CAAA;AAAA;;AAAA;AAAA,yBAAA,EAIA,sBAAsB,CAAA;AAAA,eAAA,EAChC,sBAAsB,CAAA;AAAA;AAAA;;AAAA;AAAA,QAAA,EAK7B,sBAAsB,CAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA,SAAA,EAiBrB,sBAAsB,CAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA,WAAA,EAiEpB,sBAAsB,CAAA;AAAA;AAAA,UAAA,EAG7B,OAAA,CAAQ,QAAA,GACJ,CAAA,MAAA,EAAS,sBAAsB,CAAA,gDAAA,EAAmD,wBAAwB,CAAA,EAAA,CAAA,GAC1G,CAAA,MAAA,EAAS,sBAAsB,CAAA,mDAAA,EAAsD,2BAA2B,CAAA,EAAA,CACtH,CAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA,iEAAA,EAO+D,sBAAsB,CAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA,WAAA,EA8B5E,sBAAsB,CAAA;AAAA,WAAA,EACtB,sBAAsB,CAAA;AAAA;AAAA;;;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,CAAA;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs",
|
|
3
|
-
"version": "1.17.
|
|
3
|
+
"version": "1.17.5",
|
|
4
4
|
"description": "The Backstage plugin that renders technical documentation for your components",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -77,17 +77,17 @@
|
|
|
77
77
|
"@backstage/core-components": "^0.18.9",
|
|
78
78
|
"@backstage/core-plugin-api": "^1.12.5",
|
|
79
79
|
"@backstage/errors": "^1.3.0",
|
|
80
|
-
"@backstage/frontend-plugin-api": "^0.16.
|
|
80
|
+
"@backstage/frontend-plugin-api": "^0.16.2",
|
|
81
81
|
"@backstage/integration": "^2.0.1",
|
|
82
82
|
"@backstage/integration-react": "^1.2.17",
|
|
83
83
|
"@backstage/plugin-auth-react": "^0.1.26",
|
|
84
|
-
"@backstage/plugin-catalog-react": "^2.1.
|
|
84
|
+
"@backstage/plugin-catalog-react": "^2.1.4",
|
|
85
85
|
"@backstage/plugin-search-common": "^1.2.23",
|
|
86
|
-
"@backstage/plugin-search-react": "^1.11.
|
|
86
|
+
"@backstage/plugin-search-react": "^1.11.3",
|
|
87
87
|
"@backstage/plugin-techdocs-common": "^0.1.1",
|
|
88
88
|
"@backstage/plugin-techdocs-react": "^1.3.10",
|
|
89
89
|
"@backstage/theme": "^0.7.3",
|
|
90
|
-
"@backstage/ui": "^0.14.
|
|
90
|
+
"@backstage/ui": "^0.14.2",
|
|
91
91
|
"@material-ui/core": "^4.12.2",
|
|
92
92
|
"@material-ui/icons": "^4.9.1",
|
|
93
93
|
"@material-ui/lab": "4.0.0-alpha.61",
|
|
@@ -99,13 +99,13 @@
|
|
|
99
99
|
"lodash": "^4.17.21",
|
|
100
100
|
"react-helmet": "6.1.0",
|
|
101
101
|
"react-use": "^17.2.4",
|
|
102
|
-
"zod": "^
|
|
102
|
+
"zod": "^4.0.0"
|
|
103
103
|
},
|
|
104
104
|
"devDependencies": {
|
|
105
105
|
"@backstage/cli": "^0.36.1",
|
|
106
106
|
"@backstage/core-app-api": "^1.20.0",
|
|
107
107
|
"@backstage/dev-utils": "^1.1.22",
|
|
108
|
-
"@backstage/plugin-catalog": "^2.0.
|
|
108
|
+
"@backstage/plugin-catalog": "^2.0.4",
|
|
109
109
|
"@backstage/plugin-techdocs-module-addons-contrib": "^1.1.35",
|
|
110
110
|
"@backstage/test-utils": "^1.7.17",
|
|
111
111
|
"@testing-library/dom": "^10.0.0",
|