@backstage/plugin-techdocs 0.0.0-nightly-20230207022622 → 0.0.0-nightly-20230209023017
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 +60 -7
- package/dist/esm/index-7822455f.esm.js.map +1 -1
- package/package.json +12 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20230209023017
|
|
4
4
|
|
|
5
5
|
### Minor Changes
|
|
6
6
|
|
|
@@ -11,23 +11,76 @@
|
|
|
11
11
|
|
|
12
12
|
- c8e09cc383: Fixed bug in Techdocs reader where a techdocs page with a hash in the URL did not always jump to the document anchor.
|
|
13
13
|
- cad5607411: Improve view: remove footer overlay on large screen
|
|
14
|
+
- 66e2aab4c4: `ListItem` wrapper component moved to `SearchResultListItemExtension` for all `*SearchResultListItems` that are exported as extensions. This is to make sure the list only contains list elements.
|
|
15
|
+
|
|
16
|
+
Note: If you have implemented a custom result list item, we recommend you to remove the list item wrapper to avoid nested `<li>` elements.
|
|
17
|
+
|
|
18
|
+
- 4660b63947: Create a TechDocs `<LightBox/>` addon that allows users to open images in a light-box on documentation pages, they can navigate between images if there are several on one page.
|
|
19
|
+
|
|
20
|
+
Here's an example on how to use it in a Backstage app:
|
|
21
|
+
|
|
22
|
+
```diff
|
|
23
|
+
import {
|
|
24
|
+
DefaultTechDocsHome,
|
|
25
|
+
TechDocsIndexPage,
|
|
26
|
+
TechDocsReaderPage,
|
|
27
|
+
} from '@backstage/plugin-techdocs';
|
|
28
|
+
import { TechDocsAddons } from '@backstage/plugin-techdocs-react/alpha';
|
|
29
|
+
+import { LightBox } from '@backstage/plugin-techdocs-module-addons-contrib';
|
|
30
|
+
|
|
31
|
+
const AppRoutes = () => {
|
|
32
|
+
<FlatRoutes>
|
|
33
|
+
// other plugin routes
|
|
34
|
+
<Route path="/docs" element={<TechDocsIndexPage />}>
|
|
35
|
+
<DefaultTechDocsHome />
|
|
36
|
+
</Route>
|
|
37
|
+
<Route
|
|
38
|
+
path="/docs/:namespace/:kind/:name/*"
|
|
39
|
+
element={<TechDocsReaderPage />}
|
|
40
|
+
>
|
|
41
|
+
<TechDocsAddons>
|
|
42
|
+
+ <LightBox />
|
|
43
|
+
</TechDocsAddons>
|
|
44
|
+
</Route>
|
|
45
|
+
</FlatRoutes>;
|
|
46
|
+
};
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
- Updated dependencies
|
|
50
|
+
- @backstage/core-components@0.0.0-nightly-20230209023017
|
|
51
|
+
- @backstage/catalog-model@0.0.0-nightly-20230209023017
|
|
52
|
+
- @backstage/plugin-catalog-react@0.0.0-nightly-20230209023017
|
|
53
|
+
- @backstage/plugin-search-react@0.0.0-nightly-20230209023017
|
|
54
|
+
- @backstage/config@1.0.6
|
|
55
|
+
- @backstage/core-plugin-api@1.3.0
|
|
56
|
+
- @backstage/errors@1.1.4
|
|
57
|
+
- @backstage/integration@1.4.2
|
|
58
|
+
- @backstage/integration-react@0.0.0-nightly-20230209023017
|
|
59
|
+
- @backstage/theme@0.2.16
|
|
60
|
+
- @backstage/plugin-search-common@1.2.1
|
|
61
|
+
- @backstage/plugin-techdocs-react@0.0.0-nightly-20230209023017
|
|
62
|
+
|
|
63
|
+
## 1.5.0-next.2
|
|
64
|
+
|
|
65
|
+
### Patch Changes
|
|
66
|
+
|
|
14
67
|
- 66e2aab4c4: `ListItem` wrapper component moved to `SearchResultListItemExtension` for all `*SearchResultListItems` that are exported as extensions. This is to make sure the list only contains list elements.
|
|
15
68
|
|
|
16
69
|
Note: If you have implemented a custom result list item, we recommend you to remove the list item wrapper to avoid nested `<li>` elements.
|
|
17
70
|
|
|
18
71
|
- Updated dependencies
|
|
19
|
-
- @backstage/catalog-model@
|
|
20
|
-
- @backstage/
|
|
21
|
-
- @backstage/
|
|
22
|
-
- @backstage/plugin-search-react@0.0.0-nightly-20230207022622
|
|
72
|
+
- @backstage/catalog-model@1.2.0-next.1
|
|
73
|
+
- @backstage/plugin-search-react@1.5.0-next.1
|
|
74
|
+
- @backstage/core-components@0.12.4-next.1
|
|
23
75
|
- @backstage/config@1.0.6
|
|
24
76
|
- @backstage/core-plugin-api@1.3.0
|
|
25
77
|
- @backstage/errors@1.1.4
|
|
26
78
|
- @backstage/integration@1.4.2
|
|
27
|
-
- @backstage/integration-react@
|
|
79
|
+
- @backstage/integration-react@1.1.10-next.1
|
|
28
80
|
- @backstage/theme@0.2.16
|
|
81
|
+
- @backstage/plugin-catalog-react@1.3.0-next.2
|
|
29
82
|
- @backstage/plugin-search-common@1.2.1
|
|
30
|
-
- @backstage/plugin-techdocs-react@
|
|
83
|
+
- @backstage/plugin-techdocs-react@1.1.3-next.2
|
|
31
84
|
|
|
32
85
|
## 1.5.0-next.1
|
|
33
86
|
|