@backstage/plugin-techdocs 0.0.0-nightly-20230208023037 → 0.0.0-nightly-20230210023233
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 +39 -8
- package/dist/esm/index-7822455f.esm.js.map +1 -1
- package/package.json +13 -13
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-20230210023233
|
|
4
4
|
|
|
5
5
|
### Minor Changes
|
|
6
6
|
|
|
@@ -15,19 +15,50 @@
|
|
|
15
15
|
|
|
16
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
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
|
+
|
|
18
49
|
- Updated dependencies
|
|
19
|
-
- @backstage/
|
|
20
|
-
- @backstage/
|
|
21
|
-
- @backstage/
|
|
22
|
-
- @backstage/plugin-
|
|
50
|
+
- @backstage/core-components@0.0.0-nightly-20230210023233
|
|
51
|
+
- @backstage/catalog-model@0.0.0-nightly-20230210023233
|
|
52
|
+
- @backstage/theme@0.0.0-nightly-20230210023233
|
|
53
|
+
- @backstage/plugin-catalog-react@0.0.0-nightly-20230210023233
|
|
54
|
+
- @backstage/plugin-search-react@0.0.0-nightly-20230210023233
|
|
23
55
|
- @backstage/config@1.0.6
|
|
24
56
|
- @backstage/core-plugin-api@1.3.0
|
|
25
57
|
- @backstage/errors@1.1.4
|
|
26
58
|
- @backstage/integration@1.4.2
|
|
27
|
-
- @backstage/integration-react@0.0.0-nightly-
|
|
28
|
-
- @backstage/theme@0.2.16
|
|
59
|
+
- @backstage/integration-react@0.0.0-nightly-20230210023233
|
|
29
60
|
- @backstage/plugin-search-common@1.2.1
|
|
30
|
-
- @backstage/plugin-techdocs-react@0.0.0-nightly-
|
|
61
|
+
- @backstage/plugin-techdocs-react@0.0.0-nightly-20230210023233
|
|
31
62
|
|
|
32
63
|
## 1.5.0-next.2
|
|
33
64
|
|