@backstage/plugin-techdocs 0.0.0-nightly-20220218022735 → 0.0.0-nightly-20220222022224
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 -4
- package/dist/index.d.ts +6 -11
- package/dist/index.esm.js +387 -140
- package/dist/index.esm.js.map +1 -1
- package/package.json +9 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,13 +1,38 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20220222022224
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
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
|
+
````
|
|
4
24
|
|
|
5
25
|
### Patch Changes
|
|
6
26
|
|
|
27
|
+
- 3bbb4d98c6: Changed <TechdocsPage /> to use <NotFoundErrorPage /> from createApp
|
|
28
|
+
- b776ce5aab: Replaced use of deprecated `useEntityListProvider` hook with `useEntityList`.
|
|
7
29
|
- Updated dependencies
|
|
8
|
-
- @backstage/plugin-catalog
|
|
9
|
-
- @backstage/
|
|
10
|
-
- @backstage/plugin-
|
|
30
|
+
- @backstage/plugin-catalog@0.0.0-nightly-20220222022224
|
|
31
|
+
- @backstage/core-components@0.0.0-nightly-20220222022224
|
|
32
|
+
- @backstage/plugin-catalog-react@0.0.0-nightly-20220222022224
|
|
33
|
+
- @backstage/catalog-model@0.0.0-nightly-20220222022224
|
|
34
|
+
- @backstage/integration@0.0.0-nightly-20220222022224
|
|
35
|
+
- @backstage/plugin-search@0.0.0-nightly-20220222022224
|
|
11
36
|
|
|
12
37
|
## 0.13.4
|
|
13
38
|
|
package/dist/index.d.ts
CHANGED
|
@@ -8,7 +8,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 = {
|
|
@@ -256,9 +256,7 @@ declare const techdocsPlugin: _backstage_core_plugin_api.BackstagePlugin<{
|
|
|
256
256
|
entityContent: _backstage_core_plugin_api.RouteRef<undefined>;
|
|
257
257
|
}, {}>;
|
|
258
258
|
declare const TechdocsPage: () => JSX.Element;
|
|
259
|
-
declare const EntityTechdocsContent: (_props: {
|
|
260
|
-
entity?: _backstage_catalog_model.Entity | undefined;
|
|
261
|
-
}) => JSX.Element;
|
|
259
|
+
declare const EntityTechdocsContent: (_props: {}) => JSX.Element;
|
|
262
260
|
declare const DocsCardGrid: ({ entities, }: {
|
|
263
261
|
entities: _backstage_catalog_model.Entity[] | undefined;
|
|
264
262
|
}) => JSX.Element | null;
|
|
@@ -285,19 +283,16 @@ declare type Props$1 = {
|
|
|
285
283
|
};
|
|
286
284
|
declare const Reader: ({ entityRef, onReady, withSearch, }: Props$1) => JSX.Element;
|
|
287
285
|
|
|
288
|
-
declare type TechDocsPageHeaderProps = {
|
|
286
|
+
declare type TechDocsPageHeaderProps = PropsWithChildren<{
|
|
289
287
|
entityRef: EntityName;
|
|
290
288
|
entityMetadata?: TechDocsEntityMetadata;
|
|
291
289
|
techDocsMetadata?: TechDocsMetadata;
|
|
292
|
-
}
|
|
293
|
-
declare const TechDocsPageHeader: ({ entityRef, entityMetadata, techDocsMetadata, }: TechDocsPageHeaderProps) => JSX.Element;
|
|
290
|
+
}>;
|
|
291
|
+
declare const TechDocsPageHeader: ({ entityRef, entityMetadata, techDocsMetadata, children, }: TechDocsPageHeaderProps) => JSX.Element;
|
|
294
292
|
|
|
295
293
|
declare const isTechDocsAvailable: (entity: Entity) => boolean;
|
|
296
294
|
declare const Router: () => JSX.Element;
|
|
297
|
-
declare type Props = {
|
|
298
|
-
/** @deprecated The entity is now grabbed from context instead */
|
|
299
|
-
entity?: Entity;
|
|
300
|
-
};
|
|
295
|
+
declare type Props = {};
|
|
301
296
|
declare const EmbeddedDocsRouter: (_props: Props) => JSX.Element;
|
|
302
297
|
|
|
303
298
|
export { DefaultTechDocsHome, DocsCardGrid, DocsResultListItem, DocsTable, DocsTableRow, EmbeddedDocsRouter, EntityListDocsGrid, EntityListDocsTable, EntityTechdocsContent, PanelType, Reader, Router, SyncResult, TechDocsApi, TechDocsClient, TechDocsCustomHome, TechDocsIndexPage, TechDocsPage, TechDocsPageHeader, TechDocsPageHeaderProps, TechDocsPageProps, TechDocsPageRenderFunction, TechDocsPageWrapper, TechDocsPicker, TechDocsReaderPage, TechDocsStorageApi, TechDocsStorageClient, TechdocsPage, isTechDocsAvailable, techdocsPlugin as plugin, techdocsApiRef, techdocsPlugin, techdocsStorageApiRef };
|