@backstage/plugin-techdocs 0.0.0-nightly-20220221022454 → 0.0.0-nightly-20220224022833
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 +29 -6
- package/dist/index.d.ts +9 -6
- package/dist/index.esm.js +432 -156
- package/dist/index.esm.js.map +1 -1
- package/package.json +9 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,19 +1,42 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20220224022833
|
|
4
4
|
|
|
5
5
|
### Minor Changes
|
|
6
6
|
|
|
7
7
|
- 2262fe19c9: **BREAKING**: Removed support for passing in an explicit `entity` prop to entity page extensions, which has been deprecated for a long time. This is only a breaking change at the TypeScript level, as this property was already ignored.
|
|
8
|
+
- 4faae902eb: Adjust the Tech Docs page theme as a side effect of the `mkdocs-material` theme update.
|
|
9
|
+
|
|
10
|
+
If you use the `spofify/techdocs` image to build your documentation, make sure you use version `spotify/techdocs:v0.3.7`.
|
|
11
|
+
|
|
12
|
+
**Breaking**: The `PyMdown` extensions have also been updated and some syntax may have changed, so it is recommended that you check the extension's documentation if something stops working.
|
|
13
|
+
For example, the syntax of tags below was deprecated in `PyMdown` extensions `v.7.0` and in `v.8.0.0` it has been removed. This means that the old syntax specified below no longer works.
|
|
14
|
+
|
|
15
|
+
````markdown
|
|
16
|
+
```markdown tab="tab"
|
|
17
|
+
This is some markdown
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
```markdown tab="tab 2"
|
|
21
|
+
This is some markdown in tab 2
|
|
22
|
+
```
|
|
23
|
+
````
|
|
8
24
|
|
|
9
25
|
### Patch Changes
|
|
10
26
|
|
|
27
|
+
- 3bbb4d98c6: Changed <TechdocsPage /> to use <NotFoundErrorPage /> from createApp
|
|
28
|
+
- ed09ad8093: Updated usage of the `LocationSpec` type from `@backstage/catalog-model`, which is deprecated.
|
|
29
|
+
- b776ce5aab: Replaced use of deprecated `useEntityListProvider` hook with `useEntityList`.
|
|
30
|
+
- d4f67fa728: Removed import of deprecated hook.
|
|
31
|
+
- 45e1706328: Continuation of [#9569](https://github.com/backstage/backstage/pull/9569), fix Tech Docs Reader search position to be the same width as content.
|
|
32
|
+
- 919cf2f836: Minor updates to match the new `targetRef` field of relations, and to stop consuming the `target` field
|
|
11
33
|
- Updated dependencies
|
|
12
|
-
- @backstage/plugin-catalog@0.0.0-nightly-
|
|
13
|
-
- @backstage/
|
|
14
|
-
- @backstage/catalog-
|
|
15
|
-
- @backstage/
|
|
16
|
-
- @backstage/
|
|
34
|
+
- @backstage/plugin-catalog@0.0.0-nightly-20220224022833
|
|
35
|
+
- @backstage/core-components@0.0.0-nightly-20220224022833
|
|
36
|
+
- @backstage/plugin-catalog-react@0.0.0-nightly-20220224022833
|
|
37
|
+
- @backstage/catalog-model@0.0.0-nightly-20220224022833
|
|
38
|
+
- @backstage/integration@0.0.0-nightly-20220224022833
|
|
39
|
+
- @backstage/plugin-search@0.0.0-nightly-20220224022833
|
|
17
40
|
|
|
18
41
|
## 0.13.4
|
|
19
42
|
|
package/dist/index.d.ts
CHANGED
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
3
3
|
import { DiscoveryApi, FetchApi, IdentityApi } from '@backstage/core-plugin-api';
|
|
4
4
|
import * as _backstage_catalog_model from '@backstage/catalog-model';
|
|
5
|
-
import { Entity,
|
|
5
|
+
import { Entity, EntityName } from '@backstage/catalog-model';
|
|
6
6
|
import { Config } from '@backstage/config';
|
|
7
7
|
import * as _backstage_core_components from '@backstage/core-components';
|
|
8
8
|
import { TableColumn, TableProps } from '@backstage/core-components';
|
|
9
9
|
import { UserListFilterKind } from '@backstage/plugin-catalog-react';
|
|
10
10
|
import { CSSProperties } from '@material-ui/styles';
|
|
11
|
-
import React from 'react';
|
|
11
|
+
import React, { PropsWithChildren } from 'react';
|
|
12
12
|
import * as _material_table_core from '@material-table/core';
|
|
13
13
|
|
|
14
14
|
declare type TechDocsMetadata = {
|
|
@@ -16,7 +16,10 @@ declare type TechDocsMetadata = {
|
|
|
16
16
|
site_description: string;
|
|
17
17
|
};
|
|
18
18
|
declare type TechDocsEntityMetadata = Entity & {
|
|
19
|
-
locationMetadata?:
|
|
19
|
+
locationMetadata?: {
|
|
20
|
+
type: string;
|
|
21
|
+
target: string;
|
|
22
|
+
};
|
|
20
23
|
};
|
|
21
24
|
|
|
22
25
|
/**
|
|
@@ -283,12 +286,12 @@ declare type Props$1 = {
|
|
|
283
286
|
};
|
|
284
287
|
declare const Reader: ({ entityRef, onReady, withSearch, }: Props$1) => JSX.Element;
|
|
285
288
|
|
|
286
|
-
declare type TechDocsPageHeaderProps = {
|
|
289
|
+
declare type TechDocsPageHeaderProps = PropsWithChildren<{
|
|
287
290
|
entityRef: EntityName;
|
|
288
291
|
entityMetadata?: TechDocsEntityMetadata;
|
|
289
292
|
techDocsMetadata?: TechDocsMetadata;
|
|
290
|
-
}
|
|
291
|
-
declare const TechDocsPageHeader: ({ entityRef, entityMetadata, techDocsMetadata, }: TechDocsPageHeaderProps) => JSX.Element;
|
|
293
|
+
}>;
|
|
294
|
+
declare const TechDocsPageHeader: ({ entityRef, entityMetadata, techDocsMetadata, children, }: TechDocsPageHeaderProps) => JSX.Element;
|
|
292
295
|
|
|
293
296
|
declare const isTechDocsAvailable: (entity: Entity) => boolean;
|
|
294
297
|
declare const Router: () => JSX.Element;
|