@backstage/plugin-techdocs
Version:
The Backstage plugin that renders technical documentation for your components
1,371 lines (1,193 loc) • 205 kB
Markdown
# @backstage/plugin-techdocs
## 1.13.1
### Patch Changes
- 0fe8d2e: Fixed an issue causing TechDocs to not properly handle initial redirect.
## 1.13.0
### Minor Changes
- 3c59ece: **New Frontend System Only:**
The `TechDocs` plugin is now responsible for providing an entity icon link extension to read documentation from the catalog entity page.
- ec7b35d: Introduced `backstage.io/techdocs-entity-path` annotation which allows deep linking into another entities TechDocs in conjunction with `backstage.io/techdocs-entity`.
### Patch Changes
- 18c64e9: Added the `info.packageJson` option to the plugin instance for the new frontend system.
- 9dde3ba: Improved Keyboard accessibility in techdocs.
- Updated dependencies
- @backstage/core-components@0.17.3
- @backstage/catalog-client@1.10.1
- @backstage/core-plugin-api@1.10.8
- @backstage/frontend-plugin-api@0.10.3
- @backstage/plugin-catalog-react@1.19.0
- @backstage/plugin-techdocs-react@1.3.0
- @backstage/plugin-techdocs-common@0.1.1
- @backstage/plugin-search-react@1.9.1
- @backstage/integration-react@1.2.8
- @backstage/plugin-auth-react@0.1.16
- @backstage/catalog-model@1.7.4
- @backstage/config@1.3.2
- @backstage/core-compat-api@0.4.3
- @backstage/errors@1.2.7
- @backstage/integration@1.17.0
- @backstage/theme@0.6.6
- @backstage/plugin-search-common@1.2.18
## 1.13.0-next.2
### Minor Changes
- 3c59ece: **New Frontend System Only:**
The `TechDocs` plugin is now responsible for providing an entity icon link extension to read documentation from the catalog entity page.
### Patch Changes
- Updated dependencies
- @backstage/core-components@0.17.3-next.0
- @backstage/plugin-catalog-react@1.19.0-next.2
- @backstage/plugin-search-react@1.9.1-next.1
- @backstage/frontend-plugin-api@0.10.3-next.1
- @backstage/integration-react@1.2.7
- @backstage/plugin-auth-react@0.1.16-next.0
- @backstage/plugin-techdocs-react@1.3.0-next.1
- @backstage/catalog-client@1.10.1-next.0
- @backstage/catalog-model@1.7.4
- @backstage/config@1.3.2
- @backstage/core-compat-api@0.4.3-next.2
- @backstage/core-plugin-api@1.10.7
- @backstage/errors@1.2.7
- @backstage/integration@1.17.0
- @backstage/theme@0.6.6
- @backstage/plugin-search-common@1.2.18
- @backstage/plugin-techdocs-common@0.1.1-next.0
## 1.13.0-next.1
### Patch Changes
- 9dde3ba: Improved Keyboard accessibility in techdocs.
- Updated dependencies
- @backstage/catalog-client@1.10.1-next.0
- @backstage/plugin-catalog-react@1.18.1-next.1
- @backstage/catalog-model@1.7.4
- @backstage/config@1.3.2
- @backstage/core-compat-api@0.4.3-next.1
- @backstage/core-components@0.17.2
- @backstage/core-plugin-api@1.10.7
- @backstage/errors@1.2.7
- @backstage/frontend-plugin-api@0.10.3-next.0
- @backstage/integration@1.17.0
- @backstage/integration-react@1.2.7
- @backstage/theme@0.6.6
- @backstage/plugin-auth-react@0.1.15
- @backstage/plugin-search-common@1.2.18
- @backstage/plugin-search-react@1.9.1-next.0
- @backstage/plugin-techdocs-common@0.1.1-next.0
- @backstage/plugin-techdocs-react@1.3.0-next.0
## 1.13.0-next.0
### Minor Changes
- ec7b35d: Introduced `backstage.io/techdocs-entity-path` annotation which allows deep linking into another entities TechDocs in conjunction with `backstage.io/techdocs-entity`.
### Patch Changes
- 18c64e9: Added the `info.packageJson` option to the plugin instance for the new frontend system.
- Updated dependencies
- @backstage/frontend-plugin-api@0.10.3-next.0
- @backstage/plugin-techdocs-react@1.3.0-next.0
- @backstage/plugin-techdocs-common@0.1.1-next.0
- @backstage/core-compat-api@0.4.3-next.0
- @backstage/plugin-catalog-react@1.18.1-next.0
- @backstage/plugin-search-react@1.9.1-next.0
- @backstage/integration-react@1.2.7
## 1.12.6
### Patch Changes
- fb58f20: Internal update to use the new `pluginId` option of `createFrontendPlugin`.
- 7d445da: Update keyboard focus on when clicking hash links. This fixes the issue where the "skip to content" link rendered by Material MkDocs isn't focused when used.
- 72d019d: Removed various typos
- 2ffd273: Add hover and focus styling to the "copy to clipboard" button within codeblocks in techdocs. Also added an aria-label to the button for accessibility.
- Updated dependencies
- @backstage/frontend-plugin-api@0.10.2
- @backstage/theme@0.6.6
- @backstage/integration@1.17.0
- @backstage/core-components@0.17.2
- @backstage/catalog-model@1.7.4
- @backstage/core-compat-api@0.4.2
- @backstage/plugin-search-react@1.9.0
- @backstage/plugin-catalog-react@1.18.0
- @backstage/plugin-techdocs-react@1.2.17
- @backstage/plugin-auth-react@0.1.15
- @backstage/core-plugin-api@1.10.7
- @backstage/catalog-client@1.10.0
- @backstage/config@1.3.2
- @backstage/integration-react@1.2.7
- @backstage/errors@1.2.7
- @backstage/plugin-search-common@1.2.18
- @backstage/plugin-techdocs-common@0.1.0
## 1.12.6-next.3
### Patch Changes
- Updated dependencies
- @backstage/integration@1.17.0-next.3
- @backstage/plugin-search-react@1.9.0-next.2
- @backstage/core-compat-api@0.4.2-next.3
- @backstage/core-components@0.17.2-next.1
- @backstage/core-plugin-api@1.10.7-next.0
- @backstage/plugin-catalog-react@1.18.0-next.3
- @backstage/catalog-client@1.10.0-next.0
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/errors@1.2.7
- @backstage/frontend-plugin-api@0.10.2-next.1
- @backstage/integration-react@1.2.7-next.3
- @backstage/theme@0.6.6-next.0
- @backstage/plugin-auth-react@0.1.15-next.1
- @backstage/plugin-search-common@1.2.18-next.0
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.17-next.1
## 1.12.6-next.2
### Patch Changes
- 7d445da: Update keyboard focus on when clicking hash links. This fixes the issue where the "skip to content" link rendered by Material MkDocs isn't focused when used.
- 2ffd273: Add hover and focus styling to the "copy to clipboard" button within codeblocks in techdocs. Also added an aria-label to the button for accessibility.
- Updated dependencies
- @backstage/integration@1.17.0-next.2
- @backstage/core-plugin-api@1.10.7-next.0
- @backstage/config@1.3.2
- @backstage/core-compat-api@0.4.2-next.2
- @backstage/core-components@0.17.2-next.1
- @backstage/frontend-plugin-api@0.10.2-next.1
- @backstage/integration-react@1.2.7-next.2
- @backstage/plugin-auth-react@0.1.15-next.1
- @backstage/plugin-catalog-react@1.18.0-next.2
- @backstage/plugin-search-react@1.9.0-next.1
- @backstage/plugin-techdocs-react@1.2.17-next.1
- @backstage/catalog-client@1.10.0-next.0
- @backstage/catalog-model@1.7.3
- @backstage/errors@1.2.7
- @backstage/theme@0.6.6-next.0
- @backstage/plugin-search-common@1.2.18-next.0
- @backstage/plugin-techdocs-common@0.1.0
## 1.12.6-next.1
### Patch Changes
- fb58f20: Internal update to use the new `pluginId` option of `createFrontendPlugin`.
- 72d019d: Removed various typos
- Updated dependencies
- @backstage/theme@0.6.6-next.0
- @backstage/core-components@0.17.2-next.0
- @backstage/frontend-plugin-api@0.10.2-next.0
- @backstage/core-compat-api@0.4.2-next.1
- @backstage/integration@1.16.4-next.1
- @backstage/plugin-search-react@1.9.0-next.0
- @backstage/plugin-catalog-react@1.18.0-next.1
- @backstage/plugin-techdocs-react@1.2.17-next.0
- @backstage/plugin-auth-react@0.1.15-next.0
- @backstage/integration-react@1.2.7-next.1
- @backstage/catalog-client@1.10.0-next.0
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/core-plugin-api@1.10.6
- @backstage/errors@1.2.7
- @backstage/plugin-search-common@1.2.18-next.0
- @backstage/plugin-techdocs-common@0.1.0
## 1.12.6-next.0
### Patch Changes
- Updated dependencies
- @backstage/integration@1.16.4-next.0
- @backstage/core-compat-api@0.4.2-next.0
- @backstage/plugin-catalog-react@1.18.0-next.0
- @backstage/catalog-client@1.10.0-next.0
- @backstage/integration-react@1.2.7-next.0
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/core-components@0.17.1
- @backstage/core-plugin-api@1.10.6
- @backstage/errors@1.2.7
- @backstage/frontend-plugin-api@0.10.1
- @backstage/theme@0.6.5
- @backstage/plugin-auth-react@0.1.14
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-search-react@1.8.8
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.16
## 1.12.5
### Patch Changes
- a47fd39: Removes instances of default React imports, a necessary update for the upcoming React 19 migration.
<https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html>
- Updated dependencies
- @backstage/plugin-techdocs-react@1.2.16
- @backstage/plugin-catalog-react@1.17.0
- @backstage/frontend-plugin-api@0.10.1
- @backstage/integration-react@1.2.6
- @backstage/core-compat-api@0.4.1
- @backstage/core-components@0.17.1
- @backstage/core-plugin-api@1.10.6
- @backstage/plugin-search-react@1.8.8
- @backstage/plugin-auth-react@0.1.14
- @backstage/theme@0.6.5
- @backstage/integration@1.16.3
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/errors@1.2.7
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-techdocs-common@0.1.0
## 1.12.5-next.2
### Patch Changes
- a47fd39: Removes instances of default React imports, a necessary update for the upcoming React 19 migration.
<https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html>
- Updated dependencies
- @backstage/frontend-plugin-api@0.10.1-next.1
- @backstage/integration-react@1.2.6-next.1
- @backstage/core-compat-api@0.4.1-next.2
- @backstage/core-components@0.17.1-next.1
- @backstage/core-plugin-api@1.10.6-next.0
- @backstage/plugin-techdocs-react@1.2.16-next.1
- @backstage/plugin-catalog-react@1.17.0-next.2
- @backstage/plugin-search-react@1.8.8-next.1
- @backstage/plugin-auth-react@0.1.14-next.1
- @backstage/theme@0.6.5-next.0
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/errors@1.2.7
- @backstage/integration@1.16.3-next.0
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-techdocs-common@0.1.0
## 1.12.5-next.1
### Patch Changes
- Updated dependencies
- @backstage/plugin-techdocs-react@1.2.16-next.0
- @backstage/core-components@0.17.1-next.0
- @backstage/integration-react@1.2.6-next.0
- @backstage/integration@1.16.3-next.0
- @backstage/frontend-plugin-api@0.10.1-next.0
- @backstage/plugin-auth-react@0.1.14-next.0
- @backstage/plugin-catalog-react@1.16.1-next.1
- @backstage/plugin-search-react@1.8.8-next.0
- @backstage/core-compat-api@0.4.1-next.1
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/core-plugin-api@1.10.5
- @backstage/errors@1.2.7
- @backstage/theme@0.6.4
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-techdocs-common@0.1.0
## 1.12.5-next.0
### Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@1.16.1-next.0
- @backstage/core-compat-api@0.4.1-next.0
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/core-components@0.17.0
- @backstage/core-plugin-api@1.10.5
- @backstage/errors@1.2.7
- @backstage/frontend-plugin-api@0.10.0
- @backstage/integration@1.16.2
- @backstage/integration-react@1.2.5
- @backstage/theme@0.6.4
- @backstage/plugin-auth-react@0.1.13
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-search-react@1.8.7
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.15
## 1.12.4
### Patch Changes
- fffe3c0: Fixed double scrollbar issue that would appear on the Entity TechDocs view page that would stop the page from full scrolling to the top when navigating to a new page
- 065e6b9: Excludes SVG styling from sanitization
- b5a8208: Added `TechDocsAddonsBlueprint` extension to allow adding of techdocs addons.
- ed1cb3e: Adds the page name of techdocs to the document's title.
- fe4abb8: Updates logic to check for SVG sources when inlining them.
- Updated dependencies
- @backstage/core-components@0.17.0
- @backstage/core-plugin-api@1.10.5
- @backstage/integration@1.16.2
- @backstage/plugin-search-react@1.8.7
- @backstage/frontend-plugin-api@0.10.0
- @backstage/plugin-catalog-react@1.16.0
- @backstage/core-compat-api@0.4.0
- @backstage/plugin-techdocs-react@1.2.15
- @backstage/integration-react@1.2.5
- @backstage/plugin-auth-react@0.1.13
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/errors@1.2.7
- @backstage/theme@0.6.4
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-techdocs-common@0.1.0
## 1.12.4-next.2
### Patch Changes
- Updated dependencies
- @backstage/frontend-plugin-api@0.10.0-next.2
- @backstage/plugin-catalog-react@1.16.0-next.2
- @backstage/core-compat-api@0.4.0-next.2
- @backstage/core-components@0.16.5-next.1
- @backstage/integration@1.16.2-next.0
- @backstage/plugin-search-react@1.8.7-next.2
- @backstage/plugin-techdocs-react@1.2.15-next.2
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/core-plugin-api@1.10.4
- @backstage/errors@1.2.7
- @backstage/integration-react@1.2.5-next.0
- @backstage/theme@0.6.4
- @backstage/plugin-auth-react@0.1.13-next.1
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-techdocs-common@0.1.0
## 1.12.4-next.1
### Patch Changes
- fffe3c0: Fixed double scrollbar issue that would appear on the Entity TechDocs view page that would stop the page from full scrolling to the top when navigating to a new page
- Updated dependencies
- @backstage/core-components@0.16.5-next.0
- @backstage/plugin-catalog-react@1.16.0-next.1
- @backstage/core-compat-api@0.3.7-next.1
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/core-plugin-api@1.10.4
- @backstage/errors@1.2.7
- @backstage/frontend-plugin-api@0.9.6-next.1
- @backstage/integration@1.16.1
- @backstage/integration-react@1.2.4
- @backstage/theme@0.6.4
- @backstage/plugin-auth-react@0.1.13-next.0
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-search-react@1.8.7-next.1
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.15-next.1
## 1.12.4-next.0
### Patch Changes
- 065e6b9: Excludes svg styling from sanitization
- b5a8208: Added `TechDocsAddonsBlueprint` extension to allow adding of techdocs addons.
- ed1cb3e: Adds the page name of techdoc to the document's title.
- fe4abb8: Updates logic to check for SVG sources when inlining svgs.
- Updated dependencies
- @backstage/plugin-search-react@1.8.7-next.0
- @backstage/plugin-catalog-react@1.16.0-next.0
- @backstage/plugin-techdocs-react@1.2.15-next.0
- @backstage/frontend-plugin-api@0.9.6-next.0
- @backstage/core-compat-api@0.3.7-next.0
- @backstage/integration-react@1.2.4
## 1.12.3
### Patch Changes
- eb3d91a: Use the custom error page if provided for displaying errors instead of the default error page
- 524f0af: Add missing route ref to the `/alpha` entity content extension.
- f4be934: Changed the base URL in addLinkClickListener from window.location.origin to app.baseUrl for improved path handling. This fixes an issue where Backstage, when running on a subpath, was unable to handle non-Backstage URLs of the same origin correctly.
- 1f40e6b: Add optional props to `TechDocCustomHome` to allow for more flexibility:
```tsx
import { TechDocsCustomHome } from '@backstage/plugin-techdocs';
//...
const options = { emptyRowsWhenPaging: false };
const linkDestination = (entity: Entity): string | undefined => {
return entity.metadata.annotations?.['external-docs'];
};
const techDocsTabsConfig = [
{
label: 'Recommended Documentation',
panels: [
{
title: 'Golden Path',
description: 'Documentation about standards to follow',
panelType: 'DocsCardGrid',
panelProps: { CustomHeader: () => <ContentHeader title='Golden Path'/> },
filterPredicate: entity =>
entity?.metadata?.tags?.includes('golden-path') ?? false,
},
{
title: 'Recommended',
description: 'Useful documentation',
panelType: 'InfoCardGrid',
panelProps: {
CustomHeader: () => <ContentHeader title='Recommended' />
linkDestination: linkDestination,
},
filterPredicate: entity =>
entity?.metadata?.tags?.includes('recommended') ?? false,
},
],
},
{
label: 'Browse All',
panels: [
{
description: 'Browse all docs',
filterPredicate: filterEntity,
panelType: 'TechDocsIndexPage',
title: 'All',
panelProps: { PageWrapper: React.Fragment, CustomHeader: React.Fragment, options: options },
},
],
},
];
const AppRoutes = () => {
<FlatRoutes>
<Route
path="/docs"
element={
<TechDocsCustomHome
tabsConfig={techDocsTabsConfig}
filter={{
kind: ['Location', 'Resource', 'Component'],
'metadata.annotations.featured-docs': CATALOG_FILTER_EXISTS,
}}
CustomPageWrapper={({ children }: React.PropsWithChildren<{}>) => (<PageWithHeader title="Docs" themeId="documentation">{children}</PageWithHeader>)}
/>
}
/>
</FlatRoutes>;
};
```
Add new Grid option called `InfoCardGrid` which is a more customizable card option for the Docs grid.
```tsx
<InfoCardGrid
entities={entities}
linkContent="Learn more"
linkDestination={entity => entity.metadata['external-docs']}
/>
```
Expose existing `CustomDocsPanel` so that it can be used independently if desired.
```tsx
const panels: PanelConfig[] = [
{
description: '',
filterPredicate: entity => {},
panelType: 'InfoCardGrid',
title: 'Standards',
panelProps: {
CustomHeader: () => <ContentHeader title='Recommended' />
linkDestination: linkDestination,
},
},
{
description: '',
filterPredicate: entity => {},
panelType: 'DocsCardGrid',
title: 'Contribute',
},
];
{
panels.map((config, index) => (
<CustomDocsPanel
key={index}
config={config}
entities={!!entities ? entities : []}
index={index}
/>
));
}
```
- 58ec9e7: Removed older versions of React packages as a preparatory step for upgrading to React 19. This commit does not introduce any functional changes, but removes dependencies on previous React versions, allowing for a cleaner upgrade path in subsequent commits.
- Updated dependencies
- @backstage/plugin-search-react@1.8.6
- @backstage/core-components@0.16.4
- @backstage/plugin-catalog-react@1.15.2
- @backstage/frontend-plugin-api@0.9.5
- @backstage/integration-react@1.2.4
- @backstage/core-compat-api@0.3.6
- @backstage/core-plugin-api@1.10.4
- @backstage/plugin-techdocs-react@1.2.14
- @backstage/plugin-auth-react@0.1.12
- @backstage/theme@0.6.4
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/errors@1.2.7
- @backstage/integration@1.16.1
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-techdocs-common@0.1.0
## 1.12.3-next.3
### Patch Changes
- Updated dependencies
- @backstage/frontend-plugin-api@0.9.5-next.3
- @backstage/core-compat-api@0.3.6-next.3
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/core-components@0.16.4-next.1
- @backstage/core-plugin-api@1.10.4-next.0
- @backstage/errors@1.2.7
- @backstage/integration@1.16.1
- @backstage/integration-react@1.2.4-next.0
- @backstage/theme@0.6.4-next.0
- @backstage/plugin-auth-react@0.1.12-next.1
- @backstage/plugin-catalog-react@1.15.2-next.3
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-search-react@1.8.6-next.3
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.14-next.1
## 1.12.3-next.2
### Patch Changes
- eb3d91a: Use the custom error page if provided for displaying errors instead of the default error page
- Updated dependencies
- @backstage/core-components@0.16.4-next.1
- @backstage/plugin-catalog-react@1.15.2-next.2
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/core-compat-api@0.3.6-next.2
- @backstage/core-plugin-api@1.10.4-next.0
- @backstage/errors@1.2.7
- @backstage/frontend-plugin-api@0.9.5-next.2
- @backstage/integration@1.16.1
- @backstage/integration-react@1.2.4-next.0
- @backstage/theme@0.6.4-next.0
- @backstage/plugin-auth-react@0.1.12-next.1
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-search-react@1.8.6-next.2
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.14-next.1
## 1.12.2-next.1
### Patch Changes
- 524f0af: Add missing route ref to the `/alpha` entity content extension.
- 58ec9e7: Removed older versions of React packages as a preparatory step for upgrading to React 19. This commit does not introduce any functional changes, but removes dependencies on previous React versions, allowing for a cleaner upgrade path in subsequent commits.
- Updated dependencies
- @backstage/core-components@0.16.4-next.0
- @backstage/frontend-plugin-api@0.9.5-next.1
- @backstage/integration-react@1.2.4-next.0
- @backstage/core-compat-api@0.3.6-next.1
- @backstage/core-plugin-api@1.10.4-next.0
- @backstage/plugin-techdocs-react@1.2.14-next.0
- @backstage/plugin-catalog-react@1.15.2-next.1
- @backstage/plugin-search-react@1.8.6-next.1
- @backstage/plugin-auth-react@0.1.12-next.0
- @backstage/theme@0.6.4-next.0
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/errors@1.2.7
- @backstage/integration@1.16.1
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-techdocs-common@0.1.0
## 1.12.2-next.0
### Patch Changes
- f4be934: Changed the base URL in addLinkClickListener from window.location.origin to app.baseUrl for improved path handling. This fixes an issue where Backstage, when running on a subpath, was unable to handle non-Backstage URLs of the same origin correctly.
- 1f40e6b: Add optional props to `TechDocCustomHome` to allow for more flexibility:
```tsx
import { TechDocsCustomHome } from '@backstage/plugin-techdocs';
//...
const options = { emptyRowsWhenPaging: false };
const linkDestination = (entity: Entity): string | undefined => {
return entity.metadata.annotations?.['external-docs'];
};
const techDocsTabsConfig = [
{
label: 'Recommended Documentation',
panels: [
{
title: 'Golden Path',
description: 'Documentation about standards to follow',
panelType: 'DocsCardGrid',
panelProps: { CustomHeader: () => <ContentHeader title='Golden Path'/> },
filterPredicate: entity =>
entity?.metadata?.tags?.includes('golden-path') ?? false,
},
{
title: 'Recommended',
description: 'Useful documentation',
panelType: 'InfoCardGrid',
panelProps: {
CustomHeader: () => <ContentHeader title='Recommended' />
linkDestination: linkDestination,
},
filterPredicate: entity =>
entity?.metadata?.tags?.includes('recommended') ?? false,
},
],
},
{
label: 'Browse All',
panels: [
{
description: 'Browse all docs',
filterPredicate: filterEntity,
panelType: 'TechDocsIndexPage',
title: 'All',
panelProps: { PageWrapper: React.Fragment, CustomHeader: React.Fragment, options: options },
},
],
},
];
const AppRoutes = () => {
<FlatRoutes>
<Route
path="/docs"
element={
<TechDocsCustomHome
tabsConfig={techDocsTabsConfig}
filter={{
kind: ['Location', 'Resource', 'Component'],
'metadata.annotations.featured-docs': CATALOG_FILTER_EXISTS,
}}
CustomPageWrapper={({ children }: React.PropsWithChildren<{}>) => (<PageWithHeader title="Docs" themeId="documentation">{children}</PageWithHeader>)}
/>
}
/>
</FlatRoutes>;
};
```
Add new Grid option called `InfoCardGrid` which is a more customizable card option for the Docs grid.
```tsx
<InfoCardGrid
entities={entities}
linkContent="Learn more"
linkDestination={entity => entity.metadata['external-docs']}
/>
```
Expose existing `CustomDocsPanel` so that it can be used independently if desired.
```tsx
const panels: PanelConfig[] = [
{
description: '',
filterPredicate: entity => {},
panelType: 'InfoCardGrid',
title: 'Standards',
panelProps: {
CustomHeader: () => <ContentHeader title='Recommended' />
linkDestination: linkDestination,
},
},
{
description: '',
filterPredicate: entity => {},
panelType: 'DocsCardGrid',
title: 'Contribute',
},
];
{
panels.map((config, index) => (
<CustomDocsPanel
key={index}
config={config}
entities={!!entities ? entities : []}
index={index}
/>
));
}
```
- Updated dependencies
- @backstage/plugin-search-react@1.8.6-next.0
- @backstage/frontend-plugin-api@0.9.5-next.0
- @backstage/catalog-client@1.9.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/core-compat-api@0.3.6-next.0
- @backstage/core-components@0.16.3
- @backstage/core-plugin-api@1.10.3
- @backstage/errors@1.2.7
- @backstage/integration@1.16.1
- @backstage/integration-react@1.2.3
- @backstage/theme@0.6.3
- @backstage/plugin-auth-react@0.1.11
- @backstage/plugin-catalog-react@1.15.2-next.0
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.13
## 1.12.1
### Patch Changes
- 3710b35: Allow passing down `withSearch` prop to `EntityTechdocsContent` component since it was `true` by default, now user can use the `EntityTechdocsContent` component _without_ showing the search field on top of the content.
- Updated dependencies
- @backstage/plugin-catalog-react@1.15.1
- @backstage/frontend-plugin-api@0.9.4
- @backstage/core-plugin-api@1.10.3
- @backstage/core-components@0.16.3
- @backstage/integration@1.16.1
- @backstage/catalog-model@1.7.3
- @backstage/config@1.3.2
- @backstage/core-compat-api@0.3.5
- @backstage/errors@1.2.7
- @backstage/integration-react@1.2.3
- @backstage/theme@0.6.3
- @backstage/plugin-auth-react@0.1.11
- @backstage/plugin-search-common@1.2.17
- @backstage/plugin-search-react@1.8.5
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.13
## 1.12.1-next.1
### Patch Changes
- 3710b35: Allow passing down `withSearch` prop to `EntityTechdocsContent` component since it was `true` by default, now user can use the `EntityTechdocsContent` component _without_ showing the search field on top of the content.
- Updated dependencies
- @backstage/frontend-plugin-api@0.9.4-next.0
- @backstage/core-plugin-api@1.10.3-next.0
- @backstage/core-compat-api@0.3.5-next.0
- @backstage/plugin-catalog-react@1.15.1-next.1
- @backstage/plugin-search-react@1.8.5-next.0
- @backstage/core-components@0.16.3-next.0
- @backstage/integration-react@1.2.3-next.0
- @backstage/plugin-auth-react@0.1.11-next.0
- @backstage/plugin-techdocs-react@1.2.13-next.0
- @backstage/catalog-model@1.7.3-next.0
- @backstage/config@1.3.2-next.0
- @backstage/errors@1.2.7-next.0
- @backstage/plugin-search-common@1.2.17-next.0
- @backstage/integration@1.16.1-next.0
- @backstage/theme@0.6.3
- @backstage/plugin-techdocs-common@0.1.0
## 1.12.1-next.0
### Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@1.15.1-next.0
- @backstage/integration-react@1.2.2
- @backstage/core-compat-api@0.3.4
## 1.12.0
### Minor Changes
- e153ca6: Add pagination support to TechDocs Index Page and make it the default
### Patch Changes
- 7d8777d: Added support for the Search bar in docs residing in the entity page tab, and not only the global "/docs" page.
- Updated dependencies
- @backstage/plugin-catalog-react@1.15.0
- @backstage/integration@1.16.0
- @backstage/plugin-search-react@1.8.4
- @backstage/core-compat-api@0.3.4
- @backstage/frontend-plugin-api@0.9.3
- @backstage/theme@0.6.3
- @backstage/core-components@0.16.2
- @backstage/errors@1.2.6
- @backstage/catalog-model@1.7.2
- @backstage/config@1.3.1
- @backstage/core-plugin-api@1.10.2
- @backstage/integration-react@1.2.2
- @backstage/plugin-auth-react@0.1.10
- @backstage/plugin-search-common@1.2.16
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.12
## 1.11.3-next.2
### Patch Changes
- Updated dependencies
- @backstage/core-compat-api@0.3.4-next.2
- @backstage/plugin-catalog-react@1.14.3-next.2
- @backstage/errors@1.2.6-next.0
- @backstage/catalog-model@1.7.2-next.0
- @backstage/config@1.3.1-next.0
- @backstage/core-components@0.16.2-next.2
- @backstage/core-plugin-api@1.10.2-next.0
- @backstage/frontend-plugin-api@0.9.3-next.2
- @backstage/integration@1.16.0-next.1
- @backstage/integration-react@1.2.2-next.1
- @backstage/theme@0.6.3-next.0
- @backstage/plugin-auth-react@0.1.10-next.2
- @backstage/plugin-search-common@1.2.16-next.0
- @backstage/plugin-search-react@1.8.4-next.2
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.12-next.2
## 1.11.3-next.1
### Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@1.14.3-next.1
- @backstage/core-components@0.16.2-next.1
- @backstage/catalog-model@1.7.1
- @backstage/config@1.3.0
- @backstage/core-compat-api@0.3.4-next.1
- @backstage/core-plugin-api@1.10.1
- @backstage/errors@1.2.5
- @backstage/frontend-plugin-api@0.9.3-next.1
- @backstage/integration@1.16.0-next.0
- @backstage/integration-react@1.2.2-next.0
- @backstage/theme@0.6.3-next.0
- @backstage/plugin-auth-react@0.1.10-next.1
- @backstage/plugin-search-common@1.2.15
- @backstage/plugin-search-react@1.8.4-next.1
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.12-next.1
## 1.11.3-next.0
### Patch Changes
- 7d8777d: Added support for the Search bar in docs residing in the entity page tab, and not only the global "/docs" page.
- Updated dependencies
- @backstage/integration@1.16.0-next.0
- @backstage/plugin-search-react@1.8.4-next.0
- @backstage/plugin-catalog-react@1.14.3-next.0
- @backstage/frontend-plugin-api@0.9.3-next.0
- @backstage/theme@0.6.3-next.0
- @backstage/catalog-model@1.7.1
- @backstage/config@1.3.0
- @backstage/core-compat-api@0.3.4-next.0
- @backstage/core-components@0.16.2-next.0
- @backstage/core-plugin-api@1.10.1
- @backstage/errors@1.2.5
- @backstage/integration-react@1.2.2-next.0
- @backstage/plugin-auth-react@0.1.10-next.0
- @backstage/plugin-search-common@1.2.15
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.12-next.0
## 1.11.1
### Patch Changes
- 37a7810: Fixed an issue where `<TechDocsReaderPageContent />` would re-render infinitely under certain conditions.
- e937ae7: Fix an issue with index page of documentation site being re-rendered.
- 90246a9: Fix techdocs config schema for custom elements sanitizer
- 605bdc0: Avoid page re-rendering when clicking on anchor links in the same documentation page.
- 4f0cb89: Added DomPurify sanitizer configuration for custom elements implementing RFC https://github.com/backstage/backstage/issues/26988.
See https://backstage.io/docs/features/techdocs/how-to-guides#how-to-enable-custom-elements-in-techdocs for how to enable it in the configuration.
- f246178: Removed `canvas` dev dependency.
- 4a2f73a: Fix an issue that caused the current documentation page to be re-rendered when navigating to
another one.
- Updated dependencies
- @backstage/config@1.3.0
- @backstage/theme@0.6.1
- @backstage/plugin-catalog-react@1.14.1
- @backstage/core-components@0.16.0
- @backstage/plugin-techdocs-react@1.2.10
- @backstage/catalog-model@1.7.1
- @backstage/core-compat-api@0.3.2
- @backstage/core-plugin-api@1.10.1
- @backstage/errors@1.2.5
- @backstage/frontend-plugin-api@0.9.1
- @backstage/integration@1.15.2
- @backstage/integration-react@1.2.1
- @backstage/plugin-auth-react@0.1.8
- @backstage/plugin-search-common@1.2.15
- @backstage/plugin-search-react@1.8.2
- @backstage/plugin-techdocs-common@0.1.0
## 1.11.1-next.3
### Patch Changes
- e937ae7: Fix an issue with index page of documentation site being re-rendered.
- Updated dependencies
- @backstage/core-components@0.16.0-next.2
- @backstage/plugin-catalog-react@1.14.1-next.3
- @backstage/core-compat-api@0.3.2-next.2
- @backstage/catalog-model@1.7.0
- @backstage/config@1.2.0
- @backstage/core-plugin-api@1.10.0
- @backstage/errors@1.2.4
- @backstage/frontend-plugin-api@0.9.1-next.2
- @backstage/integration@1.15.1
- @backstage/integration-react@1.2.0
- @backstage/theme@0.6.1-next.0
- @backstage/plugin-auth-react@0.1.8-next.2
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-search-react@1.8.2-next.2
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.10-next.2
## 1.11.1-next.2
### Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@1.14.1-next.2
- @backstage/catalog-model@1.7.0
- @backstage/config@1.2.0
- @backstage/core-compat-api@0.3.2-next.1
- @backstage/core-components@0.16.0-next.1
- @backstage/core-plugin-api@1.10.0
- @backstage/errors@1.2.4
- @backstage/frontend-plugin-api@0.9.1-next.1
- @backstage/integration@1.15.1
- @backstage/integration-react@1.2.0
- @backstage/theme@0.6.1-next.0
- @backstage/plugin-auth-react@0.1.8-next.1
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-search-react@1.8.2-next.1
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.10-next.1
## 1.11.1-next.1
### Patch Changes
- 90246a9: Fix techdocs config schema for custom elements sanitizer
- Updated dependencies
- @backstage/theme@0.6.1-next.0
- @backstage/catalog-model@1.7.0
- @backstage/config@1.2.0
- @backstage/core-compat-api@0.3.2-next.1
- @backstage/core-components@0.16.0-next.1
- @backstage/core-plugin-api@1.10.0
- @backstage/errors@1.2.4
- @backstage/frontend-plugin-api@0.9.1-next.1
- @backstage/integration@1.15.1
- @backstage/integration-react@1.2.0
- @backstage/plugin-auth-react@0.1.8-next.1
- @backstage/plugin-catalog-react@1.14.1-next.1
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-search-react@1.8.2-next.1
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.10-next.1
## 1.11.1-next.0
### Patch Changes
- 605bdc0: Avoid page re-rendering when clicking on anchor links in the same documentation page.
- 4f0cb89: Added DomPurify sanitizer configuration for custom elements implementing RFC https://github.com/backstage/backstage/issues/26988.
See https://backstage.io/docs/features/techdocs/how-to-guides#how-to-enable-custom-elements-in-techdocs for how to enable it in the configuration.
- f246178: Removed `canvas` dev dependency.
- 4a2f73a: Fix an issue that caused the current documentation page to be re-rendered when navigating to
another one.
- Updated dependencies
- @backstage/core-components@0.16.0-next.0
- @backstage/plugin-techdocs-react@1.2.10-next.0
- @backstage/catalog-model@1.7.0
- @backstage/config@1.2.0
- @backstage/core-compat-api@0.3.2-next.0
- @backstage/core-plugin-api@1.10.0
- @backstage/errors@1.2.4
- @backstage/frontend-plugin-api@0.9.1-next.0
- @backstage/integration@1.15.1
- @backstage/integration-react@1.2.0
- @backstage/theme@0.6.0
- @backstage/plugin-auth-react@0.1.8-next.0
- @backstage/plugin-catalog-react@1.14.1-next.0
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-search-react@1.8.2-next.0
- @backstage/plugin-techdocs-common@0.1.0
## 1.11.0
### Minor Changes
- e77ff3d: Adds support for custom background colors in code blocks and inline code within TechDocs.
### Patch Changes
- e969dc7: Move `@types/react` to a peer dependency.
- a77cb40: Make `emptyState` input optional on `entity-content:techdocs` extension so that
the default empty state extension works correctly.
- e918061: Add support for mkdocs material palette conditional hashes.
- 720a2f9: Updated dependency `git-url-parse` to `^15.0.0`.
- e8b4966: Use more of the available space for the navigation sidebar.
- Updated dependencies
- @backstage/core-components@0.15.1
- @backstage/frontend-plugin-api@0.9.0
- @backstage/integration-react@1.2.0
- @backstage/core-compat-api@0.3.1
- @backstage/core-plugin-api@1.10.0
- @backstage/plugin-techdocs-react@1.2.9
- @backstage/plugin-catalog-react@1.14.0
- @backstage/plugin-search-react@1.8.1
- @backstage/plugin-auth-react@0.1.7
- @backstage/theme@0.6.0
- @backstage/integration@1.15.1
- @backstage/catalog-model@1.7.0
- @backstage/config@1.2.0
- @backstage/errors@1.2.4
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-techdocs-common@0.1.0
## 1.11.0-next.2
### Minor Changes
- e77ff3d: Adds support for custom background colors in code blocks and inline code within TechDocs.
### Patch Changes
- e918061: Add support for mkdocs material palette conditional hashes.
- 720a2f9: Updated dependency `git-url-parse` to `^15.0.0`.
- e8b4966: Use more of the available space for the navigation sidebar.
- Updated dependencies
- @backstage/plugin-catalog-react@1.14.0-next.2
- @backstage/integration@1.15.1-next.1
- @backstage/theme@0.6.0-next.1
- @backstage/catalog-model@1.7.0
- @backstage/config@1.2.0
- @backstage/core-compat-api@0.3.1-next.2
- @backstage/core-components@0.15.1-next.2
- @backstage/core-plugin-api@1.10.0-next.1
- @backstage/errors@1.2.4
- @backstage/frontend-plugin-api@0.9.0-next.2
- @backstage/integration-react@1.2.0-next.2
- @backstage/plugin-auth-react@0.1.7-next.2
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-search-react@1.8.1-next.2
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.9-next.2
## 1.10.11-next.1
### Patch Changes
- e969dc7: Move `@types/react` to a peer dependency.
- Updated dependencies
- @backstage/core-components@0.15.1-next.1
- @backstage/frontend-plugin-api@0.9.0-next.1
- @backstage/integration-react@1.2.0-next.1
- @backstage/core-compat-api@0.3.1-next.1
- @backstage/core-plugin-api@1.10.0-next.1
- @backstage/plugin-techdocs-react@1.2.9-next.1
- @backstage/plugin-catalog-react@1.14.0-next.1
- @backstage/plugin-search-react@1.8.1-next.1
- @backstage/plugin-auth-react@0.1.7-next.1
- @backstage/theme@0.5.8-next.0
- @backstage/integration@1.15.1-next.0
- @backstage/catalog-model@1.7.0
- @backstage/config@1.2.0
- @backstage/errors@1.2.4
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-techdocs-common@0.1.0
## 1.10.10-next.0
### Patch Changes
- a77cb40: Make `emptyState` input optional on `entity-content:techdocs` extension so that
the default empty state extension works correctly.
- Updated dependencies
- @backstage/frontend-plugin-api@0.9.0-next.0
- @backstage/core-compat-api@0.3.1-next.0
- @backstage/core-components@0.15.1-next.0
- @backstage/core-plugin-api@1.10.0-next.0
- @backstage/plugin-catalog-react@1.13.1-next.0
- @backstage/plugin-search-react@1.8.1-next.0
- @backstage/catalog-model@1.7.0
- @backstage/config@1.2.0
- @backstage/errors@1.2.4
- @backstage/integration@1.15.0
- @backstage/integration-react@1.1.32-next.0
- @backstage/theme@0.5.7
- @backstage/plugin-auth-react@0.1.7-next.0
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.9-next.0
## 1.10.9
### Patch Changes
- c891b69: Add `FavoriteToggle` in `core-components` to standardise favorite marking
- fec8b57: Updated exports to use the new type parameters for extensions and extension blueprints.
- fe94ad8: Fixes left navigation positioning when using mkdocs blog plugin
- b0206dc: Added support for setting page status with 'new' and 'deprecated' values, allowing visual indication of page status in TechDocs. To use include the following at the top of your markdown file:
```markdown
---
status: new
---
```
- 836127c: Updated dependency `@testing-library/react` to `^16.0.0`.
- c7cb4c0: Add `empty-state:techdocs/entity-content` extension to allow overriding the empty state for the entity page techdocs tab.
- 97db53e: Enhanced the table hover effect with a lighter color and updated the border radius to align with Backstage's theme styling
- Updated dependencies
- @backstage/core-components@0.15.0
- @backstage/plugin-catalog-react@1.13.0
- @backstage/frontend-plugin-api@0.8.0
- @backstage/plugin-techdocs-react@1.2.8
- @backstage/core-compat-api@0.3.0
- @backstage/plugin-search-react@1.8.0
- @backstage/integration-react@1.1.31
- @backstage/catalog-model@1.7.0
- @backstage/integration@1.15.0
- @backstage/core-plugin-api@1.9.4
- @backstage/theme@0.5.7
- @backstage/plugin-auth-react@0.1.6
- @backstage/config@1.2.0
- @backstage/errors@1.2.4
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-techdocs-common@0.1.0
## 1.10.9-next.2
### Patch Changes
- c891b69: Add `FavoriteToggle` in `core-components` to standardise favorite marking
- 836127c: Updated dependency `@testing-library/react` to `^16.0.0`.
- 97db53e: Enhanced the table hover effect with a lighter color and updated the border radius to align with Backstage's theme styling
- Updated dependencies
- @backstage/core-components@0.14.11-next.1
- @backstage/plugin-catalog-react@1.13.0-next.2
- @backstage/integration-react@1.1.31-next.0
- @backstage/plugin-search-react@1.8.0-next.2
- @backstage/integration@1.15.0-next.0
- @backstage/core-compat-api@0.3.0-next.2
- @backstage/core-plugin-api@1.9.4-next.0
- @backstage/frontend-plugin-api@0.8.0-next.2
- @backstage/theme@0.5.7-next.0
- @backstage/plugin-auth-react@0.1.6-next.1
- @backstage/plugin-techdocs-react@1.2.8-next.2
- @backstage/catalog-model@1.6.0
- @backstage/config@1.2.0
- @backstage/errors@1.2.4
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-techdocs-common@0.1.0
## 1.10.9-next.1
### Patch Changes
- Updated dependencies
- @backstage/frontend-plugin-api@0.8.0-next.1
- @backstage/core-compat-api@0.3.0-next.1
- @backstage/core-components@0.14.11-next.0
- @backstage/plugin-catalog-react@1.12.4-next.1
- @backstage/catalog-model@1.6.0
- @backstage/config@1.2.0
- @backstage/core-plugin-api@1.9.3
- @backstage/errors@1.2.4
- @backstage/integration@1.14.0
- @backstage/integration-react@1.1.30
- @backstage/theme@0.5.6
- @backstage/plugin-auth-react@0.1.6-next.0
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-search-react@1.8.0-next.1
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-techdocs-react@1.2.8-next.1
## 1.10.9-next.0
### Patch Changes
- fec8b57: Updated exports to use the new type parameters for extensions and extension blueprints.
- Updated dependencies
- @backstage/frontend-plugin-api@0.8.0-next.0
- @backstage/plugin-techdocs-react@1.2.8-next.0
- @backstage/core-compat-api@0.2.9-next.0
- @backstage/plugin-catalog-react@1.12.4-next.0
- @backstage/plugin-search-react@1.8.0-next.0
- @backstage/catalog-model@1.6.0
- @backstage/config@1.2.0
- @backstage/core-components@0.14.10
- @backstage/core-plugin-api@1.9.3
- @backstage/errors@1.2.4
- @backstage/integration@1.14.0
- @backstage/integration-react@1.1.30
- @backstage/theme@0.5.6
- @backstage/plugin-auth-react@0.1.5
- @backstage/plugin-search-common@1.2.14
- @backstage/plugin-techdocs-common@0.1.0
## 1.10.8
### Patch Changes
- 69bd940: Use annotation constants from new techdocs-common package.
- c7603e8: Deprecate the old pattern of `create*Extension`, and replace it with the equivalent Blueprint implementation instead
- 27794d1: Allow for more granular control of TechDocsReaderPage styling. Theme overrides can now be provided to TechDocs without affecting the theme in other areas of Backstage.
- 4490d73: Refactor TechDocs' mkdocs-redirects support.
- 8543e72: TechDocs redirect feature now includes a notification to the user before they are redirected.
- 67e76f2: TechDocs now supports the `mkdocs-redirects` plugin. Redirects defined using the `mkdocs-redirect` plugin will be handled automatically in TechDocs. Redirecting to external urls is not supported. In the case that an external redirect url is provided, TechDocs will redirect to the current documentation site home.
- bdc5471: Fixed issue where header styles were incorrectly generated when themes used CSS variables to define font size.
- 6349099: Added config input type to the extensions
- Updated dependencies
- @backstage/frontend-plugin-api@0.7.0
- @backstage/plugin-catalog-react@1.12.3
- @backstage/plugin-search-react@1.7.14
- @backstage/core-components@0.14.10
- @backstage/core-compat-api@0.2.8
- @backstage/plugin-search-common@1.2.14
- @backstage/integration@1.14.0
- @backstage/plugin-techdocs-common@0.1.0
- @backstage/plugin-auth-react@0.1.5
- @backstage/catalog-model@1.6.0
- @backstage/config@1.2.0
- @backstage/core-plugin-api@1.9.3
- @backstage/errors@1.2.4
- @backstage/integration-react@1.1.30
- @backstage/theme@0.5.6
- @backstage/plugin-techdocs-react@1.2.7
## 1.10.8-next.3
### Patch Changes
- 27794d1: Allow for more granular control of TechDocsReaderPage styling. Theme overrides can now be provided to TechDocs without affecting the theme in other areas of Backstage.
- 8543e72: TechDocs redirect feature now includes a notification to the user before they are redirected.
- Updated dependencies
- @backstage/frontend-plugin-api@0.7.0-next.3
- @backstage/catalog-model@1.6.0-next.0
- @backstage/core-compat-api@0.2.8-next.3
- @backstage/plugin-catalog-react@1.12.3-next.3
- @backstage/plugin-search-react@1.7.14-next.3
- @backstage/config@1.2.0
- @backstage/core-components@0.14.10-next.0
- @backstage/core-plugin-api@1.9.3
- @backstage/errors@1.2.4
- @backstage/integration@1.14.0-next.0
- @backstage/integration-react@1.1.30-next.0
- @backstage/theme@0.5.6
- @backstage/plugin-auth-react@0.1.5-next.0
- @backstage/plugin-search-common@1.2.14-next.1
- @backstage/plugin-techdocs-common@0.1.0-next.0
- @backstage/plugin-techdocs-react@1.2.7-next.1
## 1.10.8-next.2
### Patch Changes
- 67e76f2: TechDocs now supports the `mkdocs-redirects` plugin. Redirects defined using the `mkdocs-redirect` plugin will be handled automatically in TechDocs. Redirecting to external urls is not supported. In the case that an external redirect url is provided, TechDocs will redirect to the current documentation site home.
- bdc5471: Fixed issue where header styles were incorrectly generated when themes used CSS variables to define font size.
- Updated dependencies
- @backstage/frontend-plugin-api@0.7.0-next.2
- @backstage/core-compat-api@0.2.8-next.2
- @backstage/plugin-search-common@1.2.14-next.1
- @backstage/plugin-search-react@1.7.14-next.2
- @backstage/plugin-catalog-react@1.12.3-next.2
- @backstage/integration@1.14.0-next.0
- @backstage/catalog-model@1.5.0
- @backstage/config@1.2.0
- @backstage/core-components@0.14.10-next.0
- @backstage/core-plugin-api@1.9.3
- @backstage/errors@1.2.4
- @backstage/integration-react@1.1.30-next.0
- @backstage/theme@0.5.6
- @backstage/plugin-auth-react@0.1.5-next.0
- @backstage/plugin-techdocs-common@0.1.0-next.0
- @backstage/plugin-techdocs-react@1.2.7-next.0
## 1.10.8-next.1
### Patch Changes
- 69bd940: Use annotation constants from new techdocs-common package.
- 6349099: Added config input type to the extensions
- Updated dependencies
- @backstage/plugin-catalog-react@1.12.3-next.1
- @backstage/plugin-techdocs-common@0.1.0-next.0
- @backstage/frontend-plugin-api@0.6.8-next.1
- @backstage/core-compat-api@0.2.8-next.1
- @backstage/plugin-search-react@1.7.14-next.1
- @backstage/integration@1.14.0-next.0
- @backstage/plugin-search-common@1.2.14-next.0
- @backstage/catalog-model@1.5.0
- @backstage/config@1.2.0
- @backstage/core-components@0.14.10-next.0
- @backstage/core-plugin-api@1.9.3
- @backstage/errors@1.2.4
- @backstage/integration-react@1.1.30-next.0
- @backstage/theme@0.5.6
- @backstage/plugin-auth-react@0.1.5-next.0
- @backstage/plugin-techdocs-react@1.2.7-next.0
## 1.10.8-next.0
### Patch Changes
- Updated dependencies
- @backstage/frontend-plugin-api@0.6.8-next.0
- @backstage/plugin-catalog-react@1.12.3-next.0
- @backstage/plugin-search-react@1.7.14-next.0
- @backstage/core-components@0.14.10-next.0
- @backstage/integration@1.14.0-next.0
- @backstage/plugin-au