Package detail

@backstage/plugin-techdocs

backstage195.7kApache-2.01.12.5

The Backstage plugin that renders technical documentation for your components

backstage, techdocs

readme

Backstage

English | 한국어 | 中文版 | Français

What is Backstage?

Backstage is an open source framework for building developer portals. Powered by a centralized software catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly without compromising autonomy.

Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end.

software-catalog

Out of the box, Backstage includes:

Backstage Software Catalog for managing all your software such as microservices, libraries, data pipelines, websites, and ML models
Backstage Software Templates for quickly spinning up new projects and standardizing your tooling with your organization’s best practices
Backstage TechDocs for making it easy to create, maintain, find, and use technical documentation, using a "docs like code" approach
Plus, a growing ecosystem of open source plugins that further expand Backstage’s customizability and functionality

Backstage was created by Spotify but is now hosted by the Cloud Native Computing Foundation (CNCF) as an Incubation level project. For more information, see the announcement.

Project roadmap

For information about the detailed project roadmap including delivered milestones, see the Roadmap.

Getting Started

To start using Backstage, see the Getting Started documentation.

Documentation

The documentation of Backstage includes:

Community

To engage with our community, you can use the following resources:

Discord chatroom - Get support or discuss the project
Contributing to Backstage - Start here if you want to contribute
RFCs - Help shape the technical direction
FAQ - Frequently Asked Questions
Code of Conduct - This is how we roll
Adopters - Companies already using Backstage
Blog - Announcements and updates
Newsletter - Subscribe to our email newsletter
Backstage Community Sessions - Join monthly meetups and explore Backstage community
Give us a star ⭐️ - If you are using Backstage or think it is an interesting project, we would love a star ❤️

Governance

See the GOVERNANCE.md document in the backstage/community repository.

License

Copyright 2020-2025 © The Backstage Authors. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page: https://www.linuxfoundation.org/trademark-usage

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

Security

Please report sensitive security issues using Spotify's bug-bounty program rather than GitHub.

For further details, see our complete security release process.

changelog

@backstage/plugin-techdocs

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

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

1.12.5-next.1

Patch Changes

Updated dependencies

1.12.5-next.0

Patch Changes

Updated dependencies

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

1.12.4-next.2

Patch Changes

Updated dependencies

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

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

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:

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.

<InfoCardGrid
  entities={entities}
  linkContent="Learn more"
  linkDestination={entity => entity.metadata['external-docs']}
/>

Expose existing CustomDocsPanel so that it can be used independently if desired.

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

1.12.3-next.3

Patch Changes

Updated dependencies

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

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

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:

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.

<InfoCardGrid
  entities={entities}
  linkContent="Learn more"
  linkDestination={entity => entity.metadata['external-docs']}
/>

Expose existing CustomDocsPanel so that it can be used independently if desired.

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

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

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

1.12.1-next.0

Patch Changes

Updated dependencies

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

1.11.3-next.2

Patch Changes

Updated dependencies

1.11.3-next.1

Patch Changes

Updated dependencies

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

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

1.11.1-next.3

Patch Changes

e937ae7: Fix an issue with index page of documentation site being re-rendered.
Updated dependencies

1.11.1-next.2

Patch Changes

Updated dependencies

1.11.1-next.1

Patch Changes

90246a9: Fix techdocs config schema for custom elements sanitizer
Updated dependencies

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

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

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

1.10.11-next.1

Patch Changes

e969dc7: Move @types/react to a peer dependency.
Updated dependencies

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

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:
```
---
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

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

1.10.9-next.1

Patch Changes

Updated dependencies

1.10.9-next.0

Patch Changes

fec8b57: Updated exports to use the new type parameters for extensions and extension blueprints.
Updated dependencies

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

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

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

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

1.10.8-next.0

Patch Changes

Updated dependencies

1.10.7

Patch Changes

8fc2622: Fixed an issue that was causing techdocs pages unnecessarily re-render on navigate.
6fa652c: Improve default sorting of docs table
605b691: Allow for searching TechDocs by entity title
60caa92: Fix double scrollbar bug in reader
Updated dependencies

1.10.7-next.2

Patch Changes

6fa652c: Improve default sorting of docs table
Updated dependencies

1.10.7-next.1

Patch Changes

60caa92: Fix double scrollbar bug in reader
Updated dependencies

1.10.7-next.0

Patch Changes

8ac9ce5: Fixed a bug with the TechDocsReaderPageProvider not re-rendering when setShadowDom is called, meaning that the useShadowDom hooks were inconsistent. This issue caused the TextSize addon changes not to reapply during navigation.
Updated dependencies

1.10.6

Patch Changes

654af4a: mkdocs-material have updated their CSS variable template, and a few are unset in Backstage. This patch adds the missing variables to ensure coverage.
cbebad1: Internal updates to allow reusing Backstage's fetchApi implementation for event source requests. This allows you to for example, override the Authorization header.
96cd13e: TechDocsIndexPage now accepts an optional ownerPickerMode for toggling the behavior of the EntityOwnerPicker, exposing a new mode <TechDocsIndexPage ownerPickerMode="all" /> particularly suitable for larger catalogs. In this new mode, EntityOwnerPicker will display all the users and groups present in the catalog.
e40bd9a: Fixed bug in CopyToClipboardButton component where positioning of the "Copy to clipboard" button in techdocs code snippets was broken in some cases.
d44a20a: Added additional plugin metadata to package.json.
1256d88: Fixed an issue preventing the TechDocsSearchBar component from opening when clicking on the arrow icon.
Updated dependencies

1.10.6-next.2

Patch Changes

d44a20a: Added additional plugin metadata to package.json.
Updated dependencies

1.10.6-next.1

Patch Changes

cbebad1: Internal updates to allow reusing Backstage's fetchApi implementation for event source requests. This allows you to for example, override the Authorization header.
Updated dependencies

1.10.6-next.0

Patch Changes

654af4a: mkdocs-material have updated their CSS variable template, and a few are unset in Backstage. This patch adds the missing variables to ensure coverage.
96cd13e: TechDocsIndexPage now accepts an optional ownerPickerMode for toggling the behavior of the EntityOwnerPicker, exposing a new mode <TechDocsIndexPage ownerPickerMode="all" /> particularly suitable for larger catalogs. In this new mode, EntityOwnerPicker will display all the users and groups present in the catalog.
e40bd9a: Fixed bug in CopyToClipboardButton component where positioning of the "Copy to clipboard" button in techdocs code snippets was broken in some cases
1256d88: Fix weird opening behaviour of the <TechDocsSearch /> component.
Updated dependencies

1.10.5

Patch Changes

d2cc139: Update path in Readme for Plugin Techdocs to show the correct setup information.
5863cf7: The techdocs.builder config is now optional and it will default to local.
Updated dependencies

1.10.5-next.2

Patch Changes

5863cf7: The techdocs.builder config is now optional and it will default to local.
Updated dependencies

1.10.5-next.1

Patch Changes

Updated dependencies

1.10.5-next.0

Patch Changes

d2cc139: Update path in Readme for Plugin Techdocs to show the correct setup information.
Updated dependencies

1.10.4

Patch Changes

abfbcfc: Updated dependency @testing-library/react to ^15.0.0.
cb1e3b0: Updated dependency @testing-library/dom to ^10.0.0.
Updated dependencies

1.10.4-next.1

Patch Changes

Updated dependencies

1.10.4-next.0

Patch Changes

Updated dependencies

1.10.3

Patch Changes

e8f026a: Use ESM exports of react-use library
Updated dependencies

1.10.2

Patch Changes

e8f026a: Use ESM exports of react-use library
Updated dependencies

1.10.1

Patch Changes

7c2d022: Fixed bug in TechDocs sidebar render that prevented scrollbar from being displayed
3f14e9f: Implement a client cookie refresh mechanism.
62bcaf8: Use the new generic refresh user cookie provider.
28f27f0: Added ESLint rule no-top-level-material-ui-4-imports to aid with the migration to Material UI v5.
Updated dependencies

1.10.1-next.2

Patch Changes

7c2d022: Fixed bug in TechDocs sidebar render that prevented scrollbar from being displayed
3f14e9f: Implement a client cookie refresh mechanism.
Updated dependencies

1.10.1-next.1

Patch Changes

Updated dependencies

1.10.1-next.0

Patch Changes

Updated dependencies

1.10.0

Minor Changes

af4d147: Updated the styling for <code> tags to avoid word break.

Patch Changes

912ca7b: Use convertLegacyRouteRefs to define routes in /alpha export plugin.
8fe56a8: Widen @types/react dependency range to include version 18.
3631fb4: Updated dependency dompurify to ^3.0.0. Updated dependency @types/dompurify to ^3.0.0.
1cae748: Updated dependency git-url-parse to ^14.0.0.
Updated dependencies

1.10.0-next.3

Patch Changes

3631fb4: Updated dependency dompurify to ^3.0.0. Updated dependency @types/dompurify to ^3.0.0.
1cae748: Updated dependency git-url-parse to ^14.0.0.
Updated dependencies

1.10.0-next.2

Patch Changes

8fe56a8: Widen @types/react dependency range to include version 18.
Updated dependencies

1.10.0-next.1

Minor Changes

af4d147: Updated the styling for <code> tags to avoid word break.

Patch Changes

Updated dependencies

1.9.4-next.0

Patch Changes

912ca7b: Use convertLegacyRouteRefs to define routes in /alpha export plugin.
Updated dependencies

1.9.3

Patch Changes

4016f21: Remove some unused dependencies
Updated dependencies

1.9.3-next.2

Patch Changes

Updated dependencies

1.9.3-next.1

Patch Changes

Updated dependencies

1.9.3-next.0

Patch Changes

4016f21: Remove some unused dependencies
Updated dependencies

1.9.2

Patch Changes

03d0b6d: The convertLegacyRouteRef utility used by the alpha exports is now imported from @backstage/core-compat-api.
a1227cc: Wrap /alpha export extension elements in backwards compatibility wrapper.
5814122: Updated /alpha exports to fit new naming patterns.
36c94b8: Refactor of the alpha exports due to API change in how extension IDs are constructed.
Updated dependencies

1.9.2-next.4

Patch Changes

Updated dependencies

1.9.2-next.3

Patch Changes

a1227cc: Wrap /alpha export extension elements in backwards compatibility wrapper.
36c94b8: Refactor of the alpha exports due to API change in how extension IDs are constructed.
Updated dependencies

1.9.2-next.2

Patch Changes

Updated dependencies

1.9.2-next.1

Patch Changes

Updated dependencies
- @backstage/core-compat-api@0.0.1-next.0

1.9.2-next.0

Patch Changes

03d0b6dcdc: The convertLegacyRouteRef utility used by the alpha exports is now imported from @backstage/core-compat-api.
Updated dependencies

1.9.0

Minor Changes

17f93d5589: A new analytics event not-found will be published when a user visits a documentation site that does not exist

Patch Changes

4728b3960d: Fixed navigation bug that caused users to not be scrolled to the top of a new page. Fixed navigation bug where using backwards and forwards browser navigation did not scroll users to the correct place on the TechDoc page.
a3add7a682: Export alpha routes and nav item extension, only available for applications that uses the new Frontend system.
71c97e7d73: The `spec.lifecycle' field in entities will now always be rendered as a string.
68fc9dc60e: Updated alpha exports according to routing changes in @backstage/frontend-plugin-api.
6c2b872153: Add official support for React 18.
0bf6ebda88: Added entity page content for the new plugin exported via /alpha.
67cc85bb14: Switched the conditional react-dom/client import to use import(...) rather than require(...).
4aa43f62aa: Updated dependency cross-fetch to ^4.0.0.
38cda52746: Added support for React 18. The new createRoot API from react-dom/client will now be used if present.
fdb5e23602: Import MissingAnnotationEmptyState from @backstage/plugin-catalog-react to remove the cyclical dependency
Updated dependencies

1.9.0-next.2

Minor Changes

#20851 17f93d5589 Thanks @agentbellnorm! - A new analytics event not-found will be published when a user visits a documentation site that does not exist

Patch Changes

#20842 fdb5e23602 Thanks @benjdlambert! - Import MissingAnnotationEmptyState from @backstage/plugin-catalog-react to remove the cyclical dependency
Updated dependencies

1.8.1-next.1

Patch Changes

Updated dependencies

1.8.1-next.0

Patch Changes

4728b3960d: Fixed navigation bug that caused users to not be scrolled to the top of a new page. Fixed navigation bug where using backwards and forwards browser navigation did not scroll users to the correct place on the TechDoc page.
a3add7a682: Export alpha routes and nav item extension, only available for applications that uses the new Frontend system.
71c97e7d73: The `spec.lifecycle' field in entities will now always be rendered as a string.
68fc9dc60e: Updated alpha exports according to routing changes in @backstage/frontend-plugin-api.
6c2b872153: Add official support for React 18.
0bf6ebda88: Added entity page content for the new plugin exported via /alpha.
67cc85bb14: Switched the conditional react-dom/client import to use import(...) rather than require(...).
38cda52746: Added support for React 18. The new createRoot API from react-dom/client will now be used if present.
Updated dependencies

1.8.0

Minor Changes

27740caa2d: Added experimental support for declarative integration via the /alpha subpath.

Patch Changes

4918f65ab2: Create an experimental TechDocsSearchResultItemExtension for declarative integration with Backstage; it can be accessed via the /alpha import.
3605370af6: Improved DocsTable to display pagination controls dynamically, appearing only when needed.
0296f272b4: The `spec.lifecycle' field in entities will now always be rendered as a string.
9a1fce352e: Updated dependency @testing-library/jest-dom to ^6.0.0.
f95af4e540: Updated dependency @testing-library/dom to ^9.0.0.
9468a67b92: Added support for React 18. The new createRoot API from react-dom/client will now be used if present.
df449a7a31: Add kind column by default to TechDocsTable
Updated dependencies

1.7.1-next.2

Patch Changes

3605370af6: Improved DocsTable to display pagination controls dynamically, appearing only when needed.
Updated dependencies

1.7.1-next.1

Patch Changes

4918f65ab2: Create an experimental TechDocsSearchResultItemExtension for declarative integration with Backstage; it can be accessed via the /alpha import.
df449a7a31: Add kind column by default to TechDocsTable
Updated dependencies

1.7.1-next.0

Patch Changes

Updated dependencies

1.7.0

Minor Changes

e44f45ac4515: This change allows a new annotation of backstage.io/techdocs-entity this ref allows you to reference another entity for its TechDocs. This allows you have a single TechDoc for all items in a system, for example you might have a frontend and a backend in the same repo. This would allow you to have TechDocs build under a System entity while referencing the system e.g.: backstage.io/techdocs-entity: system:default/example that will show the systems docs in both the TechDocs button and the TechDocs tab without needing to do duplicate builds and filling the TechDocs page with garbage.

Patch Changes

88c9525a36f3: Fixed bug in styles that caused next and previous links in footer to overlap page content.
406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
8cec7664e146: Removed @types/node dependency
Updated dependencies

1.7.0-next.3

Patch Changes

406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
Updated dependencies

1.7.0-next.2

Minor Changes

e44f45ac4515: This change allows a new annotation of backstage.io/techdocs-entity this ref allows you to reference another entity for its TechDocs. This allows you have a single TechDoc for all items in a system, for example you might have a frontend and a backend in the same repo. This would allow you to have TechDocs build under a System entity while referencing the system e.g.: backstage.io/techdocs-entity: system:default/example that will show the systems docs in both the TechDocs button and the TechDocs tab without needing to do duplicate builds and filling the TechDocs page with garbage.

Patch Changes

8cec7664e146: Removed @types/node dependency
Updated dependencies

1.6.9-next.1

Patch Changes

Updated dependencies

1.6.8-next.0

Patch Changes

88c9525a36f3: Fixed bug in styles that caused next and previous links in footer to overlap page content.
Updated dependencies

1.6.6

Patch Changes

Updated dependencies

1.6.6-next.2

Patch Changes

Updated dependencies
- @backstage/plugin-catalog-react@1.8.1-next.1
- @backstage/integration-react@1.1.16-next.1

1.6.6-next.1

Patch Changes

Updated dependencies

1.6.6-next.0

Patch Changes

Updated dependencies

1.6.5

Patch Changes

Updated dependencies

1.6.5-next.2

Patch Changes

Updated dependencies

1.6.5-next.1

Patch Changes

Updated dependencies

1.6.5-next.0

Patch Changes

Updated dependencies

1.6.4

Patch Changes

2f660eb573cc: Fix SearchBar styles & update StoryBook stories for custom styles for notchedOutline class.
956d09e8ea68: Change deprecated local references to import from shared plugin-techdocs-react plugin
e33beb1f2a8e: Make the documentation pages printable (also handy for exporting to PDF)
Updated dependencies

1.6.4-next.3

Patch Changes

e33beb1f2a8e: Make the documentation pages printable (also handy for exporting to PDF)
Updated dependencies

1.6.3-next.2

Patch Changes

Updated dependencies

1.6.3-next.1

Patch Changes

2f660eb573cc: Fix SearchBar styles & update StoryBook stories for custom styles for notchedOutline class.
Updated dependencies

1.6.3-next.0

Patch Changes

956d09e8ea68: Change deprecated local references to import from shared plugin-techdocs-react plugin
Updated dependencies

1.6.2

Patch Changes

863beb49498: Re-add the possibility to have trailing slashes in Techdocs navigation.
Updated dependencies

1.6.2-next.2

Patch Changes

Updated dependencies

1.6.2-next.1

Patch Changes

Updated dependencies

1.6.2-next.0

Patch Changes

863beb49498: Re-add the possibility to have trailing slashes in Techdocs navigation.
Updated dependencies

1.6.1

Patch Changes

6c809d1a41c: Minor visual tweaks to adapt to changes in mkdocs-material v9
b2e182cdfa4: Fixes a UI bug in search result item which rendered the item text with incorrect font size and color
847a1eee3da: Change anchor links color in Techdocs content

With the color (mkdocs supplied) used for anchor links the background and foreground colors do not have a sufficient contrast ratio. Using the link color from theme palette.
8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
2e493480626: Fix a bug in sub-path navigation due to double addition of a sub-path if one was set up in app.baseUrl.
e0c6e8b9c3c: Update peer dependencies
Updated dependencies

1.6.1-next.3

Patch Changes

2e493480626: Fix a bug in sub-path navigation due to double addition of a sub-path if one was set up in app.baseUrl.
Updated dependencies

1.6.1-next.2

Patch Changes

Updated dependencies

1.6.1-next.1

Patch Changes

6c809d1a41c: Minor visual tweaks to adapt to changes in mkdocs-material v9
847a1eee3da: Change anchor links color in Techdocs content

With the color (mkdocs supplied) used for anchor links the background and foreground colors do not have a sufficient contrast ratio. Using the link color from theme palette.
e0c6e8b9c3c: Update peer dependencies
Updated dependencies

1.6.1-next.0

Patch Changes

b2e182cdfa4: Fixes a UI bug in search result item which rendered the item text with incorrect font size and color
8e00acb28db: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)
Updated dependencies

1.6.0

Minor Changes

3f75b7607ca: Add ability to pass icon as function to have ability to customize it by search item

Patch Changes

65454876fb2: Minor API report tweaks
54a1e133b56: Fix bug that caused next and previous links not to work with certain versions of mkdocs-material
f320c299c67: The HTML tag attributes in the documentation content inserted to shadow DOM is preserved to improve accessibility
cb8ec97cdeb: Change black & white colors to be theme aware
c10384a9235: Switch to using LinkButton instead of the deprecated Button
8adfda60ae1: Updated dependency jss to ~10.10.0.
52b0022dab7: Updated dependency msw to ^1.0.0.
238cf657c09: Copy to clipboard now works in a not secure context.
Updated dependencies

1.6.0-next.2

Patch Changes

65454876fb2: Minor API report tweaks
Updated dependencies

1.6.0-next.1

Patch Changes

54a1e133b56: Fix bug that caused next and previous links not to work with certain versions of mkdocs-material
cb8ec97cdeb: Change black & white colors to be theme aware
c10384a9235: Switch to using LinkButton instead of the deprecated Button
8adfda60ae1: Updated dependency jss to ~10.10.0.
52b0022dab7: Updated dependency msw to ^1.0.0.
238cf657c09: Copy to clipboard now works in a not secure context.
Updated dependencies

1.6.0-next.0

Minor Changes

3f75b7607c: Add ability to pass icon as function to have ability to customize it by search item

Patch Changes

f320c299c6: The HTML tag attributes in the documentation content inserted to shadow DOM is preserved to improve accessibility
Updated dependencies

1.5.0

Minor Changes

20840b36b4: Update DocsTable and EntityListDocsTable to accept overrides for Material Table options.
0eaa579f89: The TechDocsSearchResultListItem component is now a search result extension. This means that when rendered as a child of components that render search extensions, the result, rank, and highlight properties are optional. See the documentation for more details.

Patch Changes

c8e09cc383: Fixed bug in Techdocs reader where a techdocs page with a hash in the URL did not always jump to the document anchor.
cad5607411: Improve view: remove footer overlay on large screen
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.

Note: If you have implemented a custom result list item, we recommend you to remove the list item wrapper to avoid nested <li> elements.

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.

Here's an example on how to use it in a Backstage app:

import {
  DefaultTechDocsHome,
  TechDocsIndexPage,
  TechDocsReaderPage,
} from '@backstage/plugin-techdocs';
import { TechDocsAddons } from '@backstage/plugin-techdocs-react/alpha';
+import { LightBox } from '@backstage/plugin-techdocs-module-addons-contrib';

const AppRoutes = () => {
  <FlatRoutes>
    // other plugin routes
    <Route path="/docs" element={<TechDocsIndexPage />}>
      <DefaultTechDocsHome />
    </Route>
    <Route
      path="/docs/:namespace/:kind/:name/*"
      element={<TechDocsReaderPage />}
    >
      <TechDocsAddons>
+       <LightBox />
      </TechDocsAddons>
    </Route>
  </FlatRoutes>;
};

Updated dependencies

1.5.0-next.2

Patch Changes

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.

Note: If you have implemented a custom result list item, we recommend you to remove the list item wrapper to avoid nested <li> elements.
Updated dependencies

1.5.0-next.1

Minor Changes

20840b36b4: Update DocsTable and EntityListDocsTable to accept overrides for Material Table options.
0eaa579f89: The TechDocsSearchResultListItem component is now a search result extension. This means that when rendered as a child of components that render search extensions, the result, rank, and highlight properties are optional. See the documentation for more details.

Patch Changes

Updated dependencies

1.4.4-next.0

Patch Changes

c8e09cc383: Fixed bug in Techdocs reader where a techdocs page with a hash in the URL did not always jump to the document anchor.
cad5607411: Improve view: remove footer overlay on large screen
Updated dependencies

1.4.3

Patch Changes

a74dd61534: Fix sizing of build log component to render all lines
80ce4e8c29: Small updates to some components to ensure theme typography properties are inherited correctly.
7115c7389b: Updated dependency jss to ~10.9.0.
Updated dependencies

1.4.3-next.2

Patch Changes

Updated dependencies

1.4.3-next.1

Patch Changes

a74dd61534: Fix sizing of build log component to render all lines
Updated dependencies

1.4.3-next.0

Patch Changes

7115c7389b: Updated dependency jss to ~10.9.0.
Updated dependencies

1.4.2

Patch Changes

Updated dependencies

1.4.1

Patch Changes

d3fea4ae0a: Internal fixes to avoid implicit usage of globals
2e701b3796: Internal refactor to use react-router-dom rather than react-router.
a19cffbeed: Update search links to only have header as linkable text
5d3058355d: Add react/forbid-elements linter rule for button, suggest Material UI Button
3280711113: Updated dependency msw to ^0.49.0.
786f1b1419: Support older versions of react-router
Updated dependencies

1.4.1-next.4

Patch Changes

2e701b3796: Internal refactor to use react-router-dom rather than react-router.
Updated dependencies

1.4.1-next.3

Patch Changes

Updated dependencies

1.4.1-next.2

Patch Changes

Updated dependencies

1.4.1-next.1

Patch Changes

d3fea4ae0a: Internal fixes to avoid implicit usage of globals
a19cffbeed: Update search links to only have header as linkable text
Updated dependencies

1.4.1-next.0

Patch Changes

3280711113: Updated dependency msw to ^0.49.0.
Updated dependencies

1.4.0

Minor Changes

5691baea69: Add ability to configure filters when using EntityListDocsGrid

The following example will render two sections of cards grid:

One section for documentations tagged as recommended
One section for documentations tagged as runbook

<EntityListDocsGrid groups={{[
  {
    title: "Recommended Documentation",
    filterPredicate: entity =>
      entity?.metadata?.tags?.includes('recommended') ?? false,
  },
  {
    title: "RunBooks Documentation",
    filterPredicate: entity =>
      entity?.metadata?.tags?.includes('runbook') ?? false,
  }
]}} />

63705e73d9: Hide document description if not provided
847fc588a6: Updated TechDocs header to include label for source code icon and updated label to reflect Kind name

Patch Changes

9e4d8e6198: Fix logic bug that broke techdocs-cli-embedded-app
e92aa15f01: Bumped canvas dependency to the latest version, which has better Node.js v18 support.
cbe11d1e23: Tweak README
7573b65232: Internal refactor of imports to avoid circular dependencies
c1784a4980: Replaces in-code uses of GitHub with Github and deprecates old versions.
3a1a999b7b: Include query parameters when navigating to relative links in documents
bd2aab4726: An analytics event matching the semantics of the click action is now captured when users click links within a TechDocs document.
Updated dependencies

1.4.0-next.2

Patch Changes

e92aa15f01: Bumped canvas dependency to the latest version, which has better Node.js v18 support.
Updated dependencies

1.4.0-next.1

Patch Changes

9e4d8e6198: Fix logic bug that broke techdocs-cli-embedded-app

1.4.0-next.0

Minor Changes

5691baea69: Add ability to configure filters when using EntityListDocsGrid

The following example will render two sections of cards grid:

One section for documentations tagged as recommended
One section for documentations tagged as runbook

<EntityListDocsGrid groups={{[
  {
    title: "Recommended Documentation",
    filterPredicate: entity =>
      entity?.metadata?.tags?.includes('recommended') ?? false,
  },
  {
    title: "RunBooks Documentation",
    filterPredicate: entity =>
      entity?.metadata?.tags?.includes('runbook') ?? false,
  }
]}} />

Patch Changes

cbe11d1e23: Tweak README
7573b65232: Internal refactor of imports to avoid circular dependencies
c1784a4980: Replaces in-code uses of GitHub with Github and deprecates old versions.
3a1a999b7b: Include query parameters when navigating to relative links in documents
Updated dependencies

1.3.3

Patch Changes

Updated dependencies

1.3.3-next.2

Patch Changes

Updated dependencies

1.3.3-next.1

Patch Changes

Updated dependencies

1.3.3-next.0

Patch Changes

Updated dependencies

1.3.2

Patch Changes

817f3196f6: Updated React Router dependencies to be peer dependencies.
eadf56bbbf: Bump git-url-parse version to ^13.0.0
3f739be9d9: Minor API signatures cleanup
763fb81e82: Internal refactor to use more type safe code when dealing with route parameters.
7d47def9c4: Removed dependency on @types/jest.
817f3196f6: Updated the TechDocsReaderPage to be compatible with React Router v6 stable.
7a95c705fa: Fixed a bug where addons wouldn't render on sub pages when using React Route v6 stable.
667d917488: Updated dependency msw to ^0.47.0.
87ec2ba4d6: Updated dependency msw to ^0.46.0.
bf5e9030eb: Updated dependency msw to ^0.45.0.
ca8d5a6eae: Use the new SearchAutocomplete component in the TechDocsSearch component to maintain consistency across search experiences and avoid code duplication.
829f14a9b0: Always update the title and sub-title when the location changes on a TechDocs reader page.
e97d616f08: Fixed a bug where scrolling for anchors where the id starts with number didn't work for the current page.
ef9ab322de: Minor API signatures cleanup
Updated dependencies

1.3.2-next.3

Patch Changes

7d47def9c4: Removed dependency on @types/jest.
Updated dependencies

1.3.2-next.2

Patch Changes

eadf56bbbf: Bump git-url-parse version to ^13.0.0
7a95c705fa: Fixed a bug where addons wouldn't render on sub pages when using React Route v6 stable.
667d917488: Updated dependency msw to ^0.47.0.
87ec2ba4d6: Updated dependency msw to ^0.46.0.
ca8d5a6eae: Use the new SearchAutocomplete component in the TechDocsSearch component to maintain consistency across search experiences and avoid code duplication.
e97d616f08: Fixed a bug where scrolling for anchors where the id starts with number didn't work for the current page.
Updated dependencies

1.3.2-next.1

Patch Changes

817f3196f6: Updated React Router dependencies to be peer dependencies.
763fb81e82: Internal refactor to use more type safe code when dealing with route parameters.
817f3196f6: Updated the TechDocsReaderPage to be compatible with React Router v6 stable.
Updated dependencies

1.3.2-next.0

Patch Changes

3f739be9d9: Minor API signatures cleanup
bf5e9030eb: Updated dependency msw to ^0.45.0.
829f14a9b0: Always update the title and sub-title when the location changes on a TechDocs reader page.
ef9ab322de: Minor API signatures cleanup
Updated dependencies

1.3.1

Patch Changes

e924d2d013: Added back reduction in size, this fixes the extremely large TeachDocs headings
b86ed4d990: Add highlight to active navigation item and navigation parents.
7a98c73dc8: Fixed techdocs sidebar layout bug for medium devices.
8acb22205c: Scroll techdocs navigation into focus and expand any nested navigation items.
Updated dependencies

1.3.1-next.2

Patch Changes

8acb22205c: Scroll techdocs navigation into focus and expand any nested navigation items.
Updated dependencies

1.3.1-next.1

Patch Changes

b86ed4d990: Add highlight to active navigation item and navigation parents.
Updated dependencies

1.3.1-next.0

Patch Changes

7a98c73dc8: Fixed techdocs sidebar layout bug for medium devices.
Updated dependencies

1.3.0

Minor Changes

ebf3eb1641: Use the same initial filter owned for the TechDocsIndexPage as for the CatalogPage.

If you prefer to keep the previous behavior, you can change the default for the initial filter to all (or starred if you rather prefer that).
```
<TechDocsIndexPage initiallySelectedFilter="all" />
```
In general, with this change you will be able to set props at TechDocsIndexPage.

Patch Changes

a70869e775: Updated dependency msw to ^0.43.0.
8006d0f9bf: Updated dependency msw to ^0.44.0.
e2d7b76f43: Upgrade git-url-parse to 12.0.0.

Motivation for upgrade is transitively upgrading parse-url which is vulnerable to several CVEs detected by Snyk.
- SNYK-JS-PARSEURL-2935944
- SNYK-JS-PARSEURL-2935947
- SNYK-JS-PARSEURL-2936249
3cbebf710e: Reorder browser tab title in Techdocs pages to have the site name first.
726577958f: Remove the 60% factor from the font size calculation of headers to use the exact size defined in BackstageTheme.
7739141ab2: Fix: When docs are shown in an entity page under the docs tab the sidebars start overlapping with the header and tabs in the page when you scroll the documentation content.
Updated dependencies

1.2.1-next.3

Patch Changes

a70869e775: Updated dependency msw to ^0.43.0.
Updated dependencies

1.2.1-next.2

Patch Changes

e2d7b76f43: Upgrade git-url-parse to 12.0.0.

Motivation for upgrade is transitively upgrading parse-url which is vulnerable to several CVEs detected by Snyk.
- SNYK-JS-PARSEURL-2935944
- SNYK-JS-PARSEURL-2935947
- SNYK-JS-PARSEURL-2936249
7739141ab2: Fix: When docs are shown in an entity page under the docs tab the sidebars start overlapping with the header and tabs in the page when you scroll the documentation content.
Updated dependencies

1.2.1-next.1

Patch Changes

726577958f: Remove the 60% factor from the font size calculation of headers to use the exact size defined in BackstageTheme.
Updated dependencies

1.2.1-next.0

Patch Changes

3cbebf710e: Reorder browser tab title in Techdocs pages to have the site name first.
Updated dependencies

1.2.0

Minor Changes

fe7614ea54: Add an optional icon to the Catalog and TechDocs search results

Patch Changes

d047d81295: Use entity title as label in TechDocsReaderPageHeader if available
8f7b1835df: Updated dependency msw to ^0.41.0.
bff65e6958: Updated sidebar-related logic to use <SidebarPinStateProvider> + useSidebarPinState() and/or <SidebarOpenStateProvider> + useSidebarOpenState() from @backstage/core-components.
915700f64f: In order to simplify analytics on top of the search experience in Backstage, the provided <*ResultListItem /> component now captures a discover analytics event instead of a click event. This event includes the result rank as its value and, like a click, the URL/path clicked to as its to attribute.
881fbd7e8d: Fix EntityTechdocsContent component to use objects instead of <Route> elements, otherwise "outlet" will be null on sub-pages and add-ons won't render.
17c059dfd0: Restructures reader style transformations to improve code readability:
- Extracts the style rules to separate files;
- Creates a hook that processes each rule;
- And creates another hook that returns a transformer responsible for injecting them into the head tag of a given element.
3b45ad701f: Packages a set of tweaks to the TechDocs addons rendering process:
- Prevents displaying sidebars until page styles are loaded and the sidebar position is updated;
- Prevents new sidebar locations from being created every time the reader page is rendered if these locations already exist;
- Centers the styles loaded event to avoid having multiple locations setting the opacity style in Shadow Dom causing the screen to flash multiple times.
9b94ade898: Use entity title in TechDocsSearch placeholder if available.
816f7475ec: Convert sanitizeDOM transformer to hook as part of code readability improvements in dom file.
50ff56a80f: Change the EntityDocsPage path to be more specific and also add integration tests for sub-routes on this page.
Updated dependencies

1.1.2-next.1

Patch Changes

8f7b1835df: Updated dependency msw to ^0.41.0.
bff65e6958: Updated sidebar-related logic to use <SidebarPinStateProvider> + useSidebarPinState() and/or <SidebarOpenStateProvider> + useSidebarOpenState() from @backstage/core-components.
Updated dependencies

1.1.2-next.0

Patch Changes

881fbd7e8d: Fix EntityTechdocsContent component to use objects instead of <Route> elements, otherwise "outlet" will be null on sub-pages and add-ons won't render.
17c059dfd0: Restructures reader style transformations to improve code readability:
- Extracts the style rules to separate files;
- Creates a hook that processes each rule;
- And creates another hook that returns a transformer responsible for injecting them into the head tag of a given element.
3b45ad701f: Packages a set of tweaks to the TechDocs addons rendering process:
- Prevents displaying sidebars until page styles are loaded and the sidebar position is updated;
- Prevents new sidebar locations from being created every time the reader page is rendered if these locations already exist;
- Centers the styles loaded event to avoid having multiple locations setting the opacity style in Shadow Dom causing the screen to flash multiple times.
816f7475ec: Convert sanitizeDOM transformer to hook as part of code readability improvements in dom file.
50ff56a80f: Change the EntityDocsPage path to be more specific and also add integration tests for sub-routes on this page.
Updated dependencies

1.1.1

Patch Changes

52419be116: Create a menu in the sub header of documentation pages, it is responsible for rendering TechDocs addons that allow users to customize their reading experience.
a307a14be0: Removed dependency on @backstage/core-app-api.
bed0d64ce9: Fixed bugs that prevented a 404 error from being shown when it should have been.
2efee91251: Add a sub-route path on the EntityDocs page to fix the blank screen error when navigating using sidebar links.
2dcb2c9678: Loading SVGs correctly with bota with extended characters
52fddad92d: The TechDocsStorageApi and its associated ref are now exported by @backstage/plugin-techdocs-react. The API interface, ref, and types are now deprecated in @backstage/plugin-techdocs and will be removed in a future release.
0ad901569f: Hidden exports related to experimental TechDocs reader functionality have been removed and can no longer be imported. In the unlikely event you were using these exports, you can now take advantage of the officially supported and generally available TechDocs Addon framework instead.
3a74e203a8: Updated search result components to support rendering content with highlighted matched terms
Updated dependencies

1.1.1-next.3

Patch Changes

cc8ddd0979: revert dependency event-source-polyfill to 1.0.25
Updated dependencies
- @backstage/core-components@0.9.4-next.2

1.1.1-next.2

Patch Changes

52419be116: Create a menu in the sub header of documentation pages, it is responsible for rendering TechDocs addons that allow users to customize their reading experience.
1af133f779: Updated dependency event-source-polyfill to 1.0.26.
2dcb2c9678: Loading SVGs correctly with bota with extended characters
3a74e203a8: Updated search result components to support rendering content with highlighted matched terms
Updated dependencies

1.1.1-next.1

Patch Changes

52fddad92d: The TechDocsStorageApi and its associated ref are now exported by @backstage/plugin-techdocs-react. The API interface, ref, and types are now deprecated in @backstage/plugin-techdocs and will be removed in a future release.
Updated dependencies

1.1.1-next.0

Patch Changes

a307a14be0: Removed dependency on @backstage/core-app-api.
bed0d64ce9: Fixed bugs that prevented a 404 error from being shown when it should have been.
Updated dependencies

1.1.0

Minor Changes

ace749b785: TechDocs supports a new, experimental method of customization: addons!

To customize the standalone TechDocs reader page experience, update your /packages/app/src/App.tsx in the following way:

import { TechDocsIndexPage, TechDocsReaderPage } from '@backstage/plugin-techdocs';
+ import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
+ import { SomeAddon } from '@backstage/plugin-some-plugin';

// ...

    <Route path="/docs" element={<TechDocsIndexPage />} />
    <Route
      path="/docs/:namespace/:kind/:name/*"
      element={<TechDocsReaderPage />}
    >
+      <TechDocsAddons>
+        <SomeAddon />
+      </TechDocsAddons>
    </Route>

// ...

To customize the TechDocs reader experience on the Catalog entity page, update your packages/app/src/components/catalog/EntityPage.tsx in the following way:

import { EntityTechdocsContent } from '@backstage/plugin-techdocs';
+ import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
+ import { SomeAddon } from '@backstage/plugin-some-plugin';

// ...

  <EntityLayoutWrapper>
    <EntityLayout.Route path="/" title="Overview">
      {overviewContent}
    </EntityLayout.Route>

    <EntityLayout.Route path="/docs" title="Docs">
-      <EntityTechDocsContent />
+      <EntityTechdocsContent>
+        <TechDocsAddons>
+          <SomeAddon />
+        </TechDocsAddons>
+      </EntityTechdocsContent>
    </EntityLayout.Route>
  </EntityLayoutWrapper>

// ...

If you do not wish to customize your TechDocs reader experience in this way at this time, no changes are necessary!

Patch Changes

ab230a433f: imports from @backstage/plugin-search-react instead of @backstage/plugin-search
7c7919777e: build(deps-dev): bump @testing-library/react-hooks from 7.0.2 to 8.0.0
24254fd433: build(deps): bump @testing-library/user-event from 13.5.0 to 14.0.0
230ad0826f: Bump to using @types/node v16
f0fb9153b7: Fix broken query selectors on techdocs
9975ff9852: Applied the fix from version 1.0.1 of this package, which is part of the v1.0.2 release of Backstage.
3ba256c389: Fixed a bug preventing custom TechDocs reader page implementations from rendering without being double-wrapped in the <TechDocsReaderPage /> component.
fe53fe97d7: Fix permalink scrolling for anchors where the id starts with a number.
0152c0de22: Some documentation layout tweaks:
- drawer toggle margins
- code block margins
- sidebar drawer width
- inner content width
- footer link width
- sidebar table of contents scroll
3ba256c389: Fixed a bug that caused addons in the Subheader location to break the default TechDocs reader page layout.
Updated dependencies

1.1.0-next.3

Minor Changes

ace749b785: TechDocs supports a new, experimental method of customization: addons!

To customize the standalone TechDocs reader page experience, update your /packages/app/src/App.tsx in the following way:

import { TechDocsIndexPage, TechDocsReaderPage } from '@backstage/plugin-techdocs';
+ import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
+ import { SomeAddon } from '@backstage/plugin-some-plugin';

// ...

    <Route path="/docs" element={<TechDocsIndexPage />} />
    <Route
      path="/docs/:namespace/:kind/:name/*"
      element={<TechDocsReaderPage />}
    >
+      <TechDocsAddons>
+        <SomeAddon />
+      </TechDocsAddons>
    </Route>

// ...

To customize the TechDocs reader experience on the Catalog entity page, update your packages/app/src/components/catalog/EntityPage.tsx in the following way:

import { EntityTechdocsContent } from '@backstage/plugin-techdocs';
+ import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
+ import { SomeAddon } from '@backstage/plugin-some-plugin';

// ...

  <EntityLayoutWrapper>
    <EntityLayout.Route path="/" title="Overview">
      {overviewContent}
    </EntityLayout.Route>

    <EntityLayout.Route path="/docs" title="Docs">
-      <EntityTechDocsContent />
+      <EntityTechdocsContent>
+        <TechDocsAddons>
+          <SomeAddon />
+        </TechDocsAddons>
+      </EntityTechdocsContent>
    </EntityLayout.Route>
  </EntityLayoutWrapper>

// ...

If you do not wish to customize your TechDocs reader experience in this way at this time, no changes are necessary!

Patch Changes

ab230a433f: imports from @backstage/plugin-search-react instead of @backstage/plugin-search
24254fd433: build(deps): bump @testing-library/user-event from 13.5.0 to 14.0.0
230ad0826f: Bump to using @types/node v16
Updated dependencies

1.0.1-next.2

Patch Changes

f0fb9153b7: Fix broken query selectors on techdocs
9975ff9852: Applied the fix from version 1.0.1 of this package, which is part of the v1.0.2 release of Backstage.
Updated dependencies

1.0.1

Patch Changes

Pin the event-source-polyfill dependency to version 1.0.25

1.0.1-next.1

Patch Changes

0152c0de22: Some documentation layout tweaks:
- drawer toggle margins
- code block margins
- sidebar drawer width
- inner content width
- footer link width
- sidebar table of contents scroll
Updated dependencies

1.0.1-next.0

Patch Changes

fe53fe97d7: Fix permalink scrolling for anchors where the id starts with a number.
Updated dependencies

1.0.0

Major Changes

b58c70c223: This package has been promoted to v1.0! To understand how this change affects the package, please check out our versioning policy.

Minor Changes

700d93ff41: Removed deprecated exports, including:
- deprecated DocsResultListItem is now deleted and fully replaced with TechDocsSearchResultListItem
- deprecated TechDocsPage is now deleted and fully replaced with TechDocsReaderPage
- deprecated TechDocsPageHeader is now deleted and fully replaced with TechDocsReaderPageHeader
- deprecated TechDocsPageHeaderProps is now deleted and fully replaced with TechDocsReaderPageHeaderProps
- deprecated TechDocsPageRenderFunction is now deleted and fully replaced with TechDocsReaderPageRenderFunction
- deprecated config techdocs.requestUrl is now deleted and fully replaced with the discoveryApi

Patch Changes

a422d7ce5e: chore(deps): bump @testing-library/react from 11.2.6 to 12.1.3
c689d7a94c: Switched to using CatalogFilterLayout from @backstage/plugin-catalog-react.
f24ef7864e: Minor typo fixes
06af9e8d17: Long sidebars will no longer overflow the footer and will properly show a scrollbar when needed.
Updated dependencies

0.15.1

Patch Changes

7a1dbe6ce9: The panels of TechDocsCustomHome now use the useEntityOwnership hook to resolve ownership when the 'ownedByUser' filter predicate is used.
Updated dependencies

0.15.1-next.0

Patch Changes

7a1dbe6ce9: The panels of TechDocsCustomHome now use the useEntityOwnership hook to resolve ownership when the 'ownedByUser' filter predicate is used.
Updated dependencies

0.15.0

Minor Changes

ee3d6c6f10: BREAKING: Table column utilities createNameColumn, createOwnerColumn, createTypeColumn as well as actions utilities createCopyDocsUrlAction and createStarEntityAction are no longer directly exported. Instead accessible through DocsTable and EntityListDocsTable.

Use as following:
```
DocsTable.columns.createNameColumn();
DocsTable.columns.createOwnerColumn();
DocsTable.columns.createTypeColumn();

DocsTable.actions.createCopyDocsUrlAction();
DocsTable.actions.createStarEntityAction();
```
- Renamed DocsResultListItem to TechDocsSearchResultListItem, leaving the old name in place as a deprecations.
- Renamed TechDocsPage to TechDocsReaderPage, leaving the old name in place as a deprecations.
- Renamed TechDocsPageRenderFunction to TechDocsPageRenderFunction, leaving the old name in place as a deprecations.
- Renamed TechDocsPageHeader to TechDocsReaderPageHeader, leaving the old name in place as a deprecations.
- LegacyTechDocsHome marked as deprecated and will be deleted in next release, use TechDocsCustomHome instead.
- LegacyTechDocsPage marked as deprecated and will be deleted in next release, use TechDocsReaderPage instead.

Patch Changes

64b430f80d: chore(deps): bump react-text-truncate from 0.17.0 to 0.18.0
899f196af5: Use getEntityByRef instead of getEntityByName in the catalog client
f41a293231: - DEPRECATION: Deprecated formatEntityRefTitle in favor of the new humanizeEntityRef method instead. Please migrate to using the new method instead.
c5fda066b1: Collapse techdocs sidebar on small devices
f590d1681b: Removed usage of deprecated favorite utility methods.
5b0f9a75fa: Remove copyright from old footer in documentation generated with previous version of mkdocs-techdocs-plugin (v0.2.2).
0c3ba547a6: Show feedback when copying code snippet to clipboard.
0ca964ee0e: Fixed a bug that could cause searches in the in-context TechDocs search bar to show results from a different TechDocs site.
36aa63022b: Use CompoundEntityRef instead of EntityName, and getCompoundEntityRef instead of getEntityName, from @backstage/catalog-model.
Updated dependencies

0.14.0

Minor Changes

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.
4faae902eb: Adjust the Tech Docs page theme as a side effect of the mkdocs-material theme update.

If you use the spofify/techdocs image to build your documentation, make sure you use version spotify/techdocs:v0.3.7.

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. 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.
```
```markdown tab="tab"
This is some markdown
```

```markdown tab="tab 2"
This is some markdown in tab 2
```
```

Patch Changes

3bbb4d98c6: Changed <TechdocsPage /> to use <NotFoundErrorPage /> from createApp
ed09ad8093: Updated usage of the LocationSpec type from @backstage/catalog-model, which is deprecated.
b776ce5aab: Replaced use of deprecated useEntityListProvider hook with useEntityList.
d4f67fa728: Removed import of deprecated hook.
45e1706328: Continuation of #9569, fix Tech Docs Reader search position to be the same width as content.
919cf2f836: Minor updates to match the new targetRef field of relations, and to stop consuming the target field
Updated dependencies

0.13.4

Patch Changes

1ed305728b: Bump node-fetch to version 2.6.7 and cross-fetch to version 3.1.5
c77c5c7eb6: Added backstage.role to package.json
6553985cd4: Match text size of admonitions to main content text size.
9df7b43e1a: Improve overall appearance of highlighted code in docs.
Updated dependencies

0.13.3

Patch Changes

Updated dependencies

0.13.3-next.0

Patch Changes

Updated dependencies

0.13.2

Patch Changes

742434a6ba: Fixed a bug where links to files within a TechDocs site that use the download attribute would result in a 404 in cases where the TechDocs backend and Backstage frontend application are on the same host.
359c31e31d: Added support for documentation using the raw <source> tag to point to relative resources like audio or video files.
18317a08db: Fixed a bug where copy-to-clipboard buttons were appended to unintended elements.
Updated dependencies

0.13.2-next.1

Patch Changes

742434a6ba: Fixed a bug where links to files within a TechDocs site that use the download attribute would result in a 404 in cases where the TechDocs backend and Backstage frontend application are on the same host.
Updated dependencies

0.13.2-next.0

Patch Changes

359c31e31d: Added support for documentation using the raw <source> tag to point to relative resources like audio or video files.
Updated dependencies

0.13.1

Patch Changes

bdc53553eb: chore(deps): bump react-text-truncate from 0.16.0 to 0.17.0
a64f99f734: Code snippets now include a "copy to clipboard" button.
Updated dependencies

0.13.0

Minor Changes

aecfe4f403: Make TechDocsClient and TechDocsStorageClient use the FetchApi. You now need to pass in an instance of that API when constructing the client, if you create a custom instance in your app.

If you are replacing the factory:

+import { fetchApiRef } from '@backstage/core-plugin-api';

 createApiFactory({
   api: techdocsStorageApiRef,
   deps: {
     configApi: configApiRef,
     discoveryApi: discoveryApiRef,
     identityApi: identityApiRef,
+    fetchApi: fetchApiRef,
   },
   factory: ({
     configApi,
     discoveryApi,
     identityApi,
+    fetchApi,
   }) =>
     new TechDocsStorageClient({
       configApi,
       discoveryApi,
       identityApi,
+      fetchApi,
     }),
 }),
 createApiFactory({
   api: techdocsApiRef,
   deps: {
     configApi: configApiRef,
     discoveryApi: discoveryApiRef,
-    identityApi: identityApiRef,
+    fetchApi: fetchApiRef,
   },
   factory: ({
     configApi,
     discoveryApi,
-    identityApi,
+    fetchApi,
   }) =>
     new TechDocsClient({
       configApi,
       discoveryApi,
-      identityApi,
+      fetchApi,
     }),
 }),

If instantiating directly:

+import { fetchApiRef } from '@backstage/core-plugin-api';

+const fetchApi = useApi(fetchApiRef);
 const storageClient = new TechDocsStorageClient({
   configApi,
   discoveryApi,
   identityApi,
+  fetchApi,
 });
 const techdocsClient = new TechDocsClient({
   configApi,
   discoveryApi,
-  identityApi,
+  fetchApi,
 }),

Patch Changes

51fbedc445: Migrated usage of deprecated IdentityApi methods.
29710c91c2: use lighter color for block quotes and horizontal rulers
Updated dependencies

0.12.15-next.0

Patch Changes

51fbedc445: Migrated usage of deprecated IdentityApi methods.
29710c91c2: use lighter color for block quotes and horizontal rulers
Updated dependencies

0.12.14

Patch Changes

5333451def: Cleaned up API exports
1628ca3f49: Fix an issue where the TechDocs sidebar is hidden when the Backstage sidebar is pinned at smaller screen sizes
Updated dependencies

0.12.13

Patch Changes

fe9de6c25b: Adds support for opening internal Techdocs links in a new tab with CTRL+Click or CMD+Click
4ce51ab0f1: Internal refactor of the react-use imports to use react-use/lib/* instead.
e0271456d8: Updated Techdocs footer navigation to dynamically resize to the width of the dom, resolving an issue where a pinned sidebar causes navigation to go off of the screen
Updated dependencies

0.12.12

Patch Changes

aa8f764a3e: Add the techdocs.sanitizer.allowedIframeHosts config. This config allows all iframes which have the host of the attribute src in the 'allowedIframehosts' list to be displayed in the documentation.
Updated dependencies

0.12.11

Patch Changes

Updated dependencies

0.12.10

Patch Changes

e7cce2b603: Fix issue where assets weren't being fetched from the correct URL path for doc URLs without trailing slashes
Updated dependencies

0.12.9

Patch Changes

cd450844f6: Moved React dependencies to peerDependencies and allow both React v16 and v17 to be used.
d90dad84b0: Switch to using LogViewer component from @backstage/core-components to display build logs.
3421826ca8: The problem of lowercase entity triplets which causes docs to not load on entity page is fixed.
Updated dependencies

0.12.8

Patch Changes

Updated dependencies

0.12.7

Patch Changes

bab752e2b3: Change default port of backend from 7000 to 7007.

This is due to the AirPlay Receiver process occupying port 7000 and preventing local Backstage instances on MacOS to start.

You can change the port back to 7000 or any other value by providing an app-config.yaml with the following values:
```
backend:
  listen: 0.0.0.0:7123
  baseUrl: http://localhost:7123
```
More information can be found here: https://backstage.io/docs/conf/writing
Updated dependencies

0.12.6

Patch Changes

a125278b81: Refactor out the deprecated path and icon from RouteRefs
c1858c4cf9: Fixed entity triplet case handling for certain locales.
f7703981a9: Use a better checkbox rendering in a task list.
e266687580: Updates reader component used to display techdocs documentation. A previous change made this component not usable out of a page which don't have entityRef in url parameters. Reader component EntityRef parameter is now used instead of url parameters. Techdocs documentation component can now be used in our custom pages.
Updated dependencies

0.12.5

Patch Changes

fe5738fe1c: Lazy load LazyLog as it is rarely used.
53c9ad7e04: Update font weight for headings in TechDocs
Updated dependencies

0.12.4

Patch Changes

a9a8c6f7c5: Reader will now scroll to the top of the page when navigating between pages
106a5dc3ad: Restore original casing for kind, namespace and name in DefaultTechDocsCollator.
Updated dependencies

0.12.3

Patch Changes

ba5b75ed2f: Add <EntityListDocsGrid> as an alternative to <EntityListDocsTable> that shows a grid of card instead of table.

Extend <DocsCardGrid> to display the entity title of the entity instead of the name if available.
177401b571: Display entity title (if defined) in titles of TechDocs search results
cdf8ca6111: Only replace the shadow dom if the content is changed to avoid a flickering UI.
Updated dependencies

0.12.2

Patch Changes

76fef740fe: Refactored <Reader /> component internals to support future extensibility.
Updated dependencies

0.12.1

Patch Changes

81a41ec249: Added a name key to all extensions in order to improve Analytics API metadata.
Updated dependencies

0.12.0

Minor Changes

82bb0842a3: Adds support for being able to customize and compose your TechDocs reader page in the App.

You can likely upgrade to this version without issue. If, however, you have imported the <Reader /> component in your custom code, the name of a property has changed. You will need to make the following change anywhere you use it:
```
-<Reader entityId={value} />
+<Reader entityRef={value} />
```

Patch Changes

79ebee7a6b: Add "data-testid" for e2e tests and fix techdocs entity not found error.
3df2e8532b: Fixed the URL for the "Click to copy documentation link to clipboard" action
0a8bec0877: Added a check for the TechDocs annotation on the entity
Updated dependencies

0.11.3

Patch Changes

be13dfe61a: Make techdocs context search bar width adjust on smaller screens.
Updated dependencies

0.11.2

Patch Changes

1d346ba903: Modify TechDocsCollator to be aware of new TechDocs URL pattern. Modify tech docs in context search to use correct casing when creating initial filter.
9f1362dcc1: Upgrade @material-ui/lab to 4.0.0-alpha.57.
96fef17a18: Upgrade git-parse-url to v11.6.0
Updated dependencies

0.11.1

Patch Changes

30ed662a3: Adding in-context search to TechDocs Reader component. Using existing search-backend to query for indexed search results scoped into a specific entity's techdocs. Needs TechDocsCollator enabled on the backend to work.

Adding extra information to indexed tech docs documents for search.
434dfc5d4: Display metadata.title for components on the TechDocs homepage, if defined; otherwise fall back to metadata.name as displayed before.
Updated dependencies

0.11.0

Minor Changes

c772d9a84: TechDocs sites can now be accessed using paths containing entity triplets of any case (e.g. /docs/namespace/KIND/name or /docs/namespace/kind/name).

If you do not use an external storage provider for serving TechDocs, this is a transparent change and no action is required from you.

If you do use an external storage provider for serving TechDocs (one of* GCS, AWS S3, or Azure Blob Storage), you must run a migration command against your storage provider before updating.

A migration guide is available here.
- (*) We're seeking help from the community to bring OpenStack Swift support to feature parity with the above.
787bc0826: The TechDocs plugin has completed the migration to the Composability API. In order to update to this version, please ensure you've made all necessary changes to your App.tsx file as outlined in the create-app changelog.

Patch Changes

90c68a2ca: Fix Techdocs feedback icon link for GitHub URLs
Updated dependencies

0.10.4

Patch Changes

a440d3b38: Expose a new composable TechDocsIndexPage and a DefaultTechDocsHome with support for starring docs and filtering on owned, starred, owner, and tags.

You can migrate to the new UI view by making the following changes in your App.tsx:

-    <Route path="/docs" element={<TechdocsPage />} />
+    <Route path="/docs" element={<TechDocsIndexPage />}>
+      <DefaultTechDocsHome />
+    </Route>
+    <Route
+      path="/docs/:namespace/:kind/:name/*"
+      element={<TechDocsReaderPage />}
+    />

56c773909: Switched @types/react dependency to request * rather than a specific version.
8a3e46591: Switch EventSource implementation with header support from a Node.js API-based one to an XHR-based one.
Updated dependencies

0.10.3

Patch Changes

260c053b9: Fix All Material UI Warnings
db58cf06c: Avoid sanitize safe links in the header of document pages.
1d65bd490: Fix Techdocs feedback icon link for GitLab URLs with subgroup(s) in path
Updated dependencies

0.10.2

Patch Changes

9d40fcb1e: - Bumping material-ui/core version to at least 4.12.2 as they made some breaking changes in later versions which broke Pagination of the Table.
- Switching out material-table to @material-table/core for support for the later versions of material-ui/core
- This causes a minor API change to @backstage/core-components as the interface for Table re-exports the prop from the underlying Table components.
- onChangeRowsPerPage has been renamed to onRowsPerPageChange
- onChangePage has been renamed to onPageChange
- Migration guide is here: https://material-table-core.com/docs/breaking-changes
11c370af2: Optimize load times by only fetching entities with the backstage.io/techdocs-ref annotation
2b1ac002d: TechDocs now uses a "safe by default" sanitization library, rather than relying on its own, hard-coded list of allowable tags and attributes.
Updated dependencies

0.10.1

Patch Changes

9266b80ab: Add search list item to display tech docs search results
03bf17e9b: Improve the responsiveness of the EntityPage UI. With this the Header component should scale with the screen size & wrapping should not cause overflowing/blocking of links. Additionally enforce the Pages using the Grid Layout to use it across all screen sizes & to wrap as intended.

To benefit from the improved responsive layout, the EntityPage in existing Backstage applications should be updated to set the xs column size on each grid item in the page, as this does not default. For example:
```
-  <Grid item md={6}>
+  <Grid item xs={12} md={6}>
```
378cc6a54: Only update the path when the content is updated. If content and path are updated independently, the frontend rendering is triggered twice on each navigation: Once for the path change (with the old content) and once for the new content. This might result in a flickering rendering that is caused by the async frontend preprocessing, and the fact that replacing the shadow dom content is expensive.
214e7c52d: Refactor the techdocs transformers to return Promises and await all transformations.
e35b13afa: Handle error responses in getTechDocsMetadata and getEntityMetadata such that <TechDocsPageHeader> doesn't throw errors.
Updated dependencies
- @backstage/core-components@0.1.6
- @backstage/plugin-catalog-react@0.3.1

0.10.0

Minor Changes

94a54dd47: Added a migrateDocsCase() method to TechDocs publishers, along with implementations for AWS, Azure, and GCS.

This change is in support of a future update to TechDocs that will allow for case-insensitive entity triplet URL access to documentation pages which will require a migration of existing documentation objects in external storage solutions.

See #4367 for details.

Patch Changes

537c37b0f: Fix displaying owned documents list by fetching associated entity relations
136a91974: Show a "Refresh" button to if the content is stale. This removes the need to do a full page-reload to display more recent TechDocs content.
f1200f44c: Rewrite the /sync/:namespace/:kind/:name endpoint to support an event-stream as response. This change allows the sync process to take longer than a normal HTTP timeout. The stream also emits log events, so the caller can follow the build process in the frontend.
3af126cdd: Provide a Drawer component to follow a running build. This can be used to debug the rendering and get build logs in case an error occurs.
2a4a3b32d: Techdocs: fix sidebars not adjusting position automatically
Updated dependencies
- @backstage/plugin-catalog-react@0.3.0

0.9.9

Patch Changes

0172d3424: Fixed bug preventing scroll bar from showing up on code blocks in a TechDocs site.
Updated dependencies

0.9.8

Patch Changes

99a2873c7: Include cookies when making fetch requests for SVG from techdocs plugin
a444c7431: Filter fetched entity fields to optimize loading techdocs list
Updated dependencies

0.9.7

Patch Changes

aefd54da6: Fix the overlapping between the sidebar and the tabs navigation when enabled in mkdocs (features: navigation.tabs)
48c9fcd33: Migrated to use the new @backstage/core-* packages rather than @backstage/core.
1dfec7a2a: Refactor the implicit logic from <Reader /> into an explicit state machine. This resolves some state synchronization issues when content is refreshed or rebuilt in the backend.
Updated dependencies

0.9.6

Patch Changes

938aee2fb: Fix the link to the documentation page when no owned documents are displayed
2e1fbe203: Do not add trailing slash for .html pages during doc links rewriting
9b57fda8b: Fixes a bug that could prevent some externally hosted images (like icons or build badges) from rendering within TechDocs documentation.
667656c8b: Adding support for user owned document filter for TechDocs custom Homepage
Updated dependencies

0.9.5

Patch Changes

aad98c544: Fixes multiple XSS and sanitization bypass vulnerabilities in TechDocs.
Updated dependencies [e7c5e4b30]
Updated dependencies [ebe802bc4]
Updated dependencies [49d7ec169]
Updated dependencies [1cf1d351f]
Updated dependencies [deaba2e13]
Updated dependencies [8e919a6f8]

0.9.4

Patch Changes

4ea9df9d3: Set admonition font size to 1rem in TechDocs to align with the rest of the document's font sizes. Fixes #5448 and #5541.
bf805b467: Fixes #5529, a bug that prevented TechDocs from rendering pages containing malformed links.
203ce6f6f: TechDocs now respects the download attribute on anchor tags in generated markup, allowing documentation authors to bundle downloadable files with their documentation.
Updated dependencies [0fd4ea443]
Updated dependencies [add62a455]
Updated dependencies [cc592248b]
Updated dependencies [17c497b81]
Updated dependencies [704875e26]

0.9.3

Patch Changes

65e6c4541: Remove circular dependencies
a62cfe068: Bug fix on sidebar position when Tab-Bar is enabled
35e091604: Handle URLs with a #hash correctly when rewriting link URLs.
Updated dependencies [f7f7783a3]
Updated dependencies [65e6c4541]
Updated dependencies [68fdbf014]
Updated dependencies [5da6a561d]

0.9.2

Patch Changes

062bbf90f: chore: bump @testing-library/user-event from 12.8.3 to 13.1.8
675a569a9: chore: bump react-use dependency in all packages
Updated dependencies [062bbf90f]
Updated dependencies [10c008a3a]
Updated dependencies [889d89b6e]
Updated dependencies [16be1d093]
Updated dependencies [3f988cb63]
Updated dependencies [675a569a9]

0.9.1

Patch Changes

2e05277e0: Fix navigation in a page using the table of contents.
4075c6367: Make git config optional for techdocs feedback links
Updated dependencies [38ca05168]
Updated dependencies [f65adcde7]
Updated dependencies [81c54d1f2]
Updated dependencies [80888659b]
Updated dependencies [7b8272fb7]
Updated dependencies [d8b81fd28]

0.9.0

Minor Changes

21fddf452: Make techdocsStorageApiRef and techdocsApiRef use interfaces instead of the actual implementation classes.

This renames the classes TechDocsApi to TechDocsClient and TechDocsStorageApi to TechDocsStorageClient and renames the interfaces TechDocs to TechDocsApi and TechDocsStorage to TechDocsStorageApi to comply the pattern elsewhere in the project. This also fixes the types returned by some methods on those interfaces.

Patch Changes

6fbd7beca: Use EntityRefLink in header and use relations to reference the owner of the document.
15cbe6815: Fix TechDocs landing page table wrong copied link
39bdaa004: Add customization and exportable components for TechDocs landing page
cb8c848a3: Disable color transitions on links to avoid issues in dark mode.
17915e29b: Rework state management to avoid rendering multiple while navigating between pages.
Updated dependencies [9afcac5af]
Updated dependencies [e0c9ed759]
Updated dependencies [6eaecbd81]
- @backstage/core@0.7.7

0.8.0

Minor Changes

ac6025f63: Add feedback link icon in Techdocs Reader that directs to GitLab or GitHub repo issue page with pre-filled title and source link. For link to appear, requires repo_url and edit_uri to be filled in mkdocs.yml, as per https://www.mkdocs.org/user-guide/configuration. An edit_uri will need to be specified for self-hosted GitLab/GitHub instances with a different host name. To identify issue URL format as GitHub or GitLab, the host name of source in repo_url is checked if it contains gitlab or github. Alternately this is determined by matching to host values from integrations in app-config.yaml.

Patch Changes

e292e393f: Add a test id to the shadow root element of the Reader to access it easily in e2e tests
Updated dependencies [94da20976]
Updated dependencies [d8cc7e67a]
Updated dependencies [99fbef232]
Updated dependencies [ab07d77f6]
Updated dependencies [931b21a12]
Updated dependencies [937ed39ce]
Updated dependencies [9a9e7a42f]
Updated dependencies [50ce875a0]
- @backstage/core@0.7.6
- @backstage/theme@0.2.6

0.7.2

Patch Changes

fef852ecd: Reworked the TechDocs plugin to support using the configured company name instead of 'Backstage' in the page title.
18f7345a6: Add borders to TechDocs tables and increase font size. Fixes #5264 and #5276.
Updated dependencies [bb5055aee]
Updated dependencies [d0d1c2f7b]
Updated dependencies [5d0740563]
Updated dependencies [5cafcf452]
Updated dependencies [86a95ba67]
Updated dependencies [e27cb6c45]
- @backstage/catalog-model@0.7.7
- @backstage/core@0.7.5

0.7.1

Patch Changes

bebd1c4fe: Remove the @backstage/techdocs-common dependency to not pull in backend config schemas in the frontend.
Updated dependencies [9f48b548c]
Updated dependencies [8488a1a96]
- @backstage/plugin-catalog-react@0.1.4
- @backstage/catalog-model@0.7.5

0.7.0

Minor Changes

aaeb7ecf3: When newer documentation available but not built, show older documentation while async building newer TechDocs backend: /sync endpoint added to support above, returns immediate success if docs don't need a build, returns delayed success after build if needed TechDocs backend: /docs endpoint removed as frontend can directly request to techdocs.storageUrl or /static/docs
3139f83af: Add sticky sidebars and footer navigation links to TechDocs Reader

Patch Changes

ea9d977e7: Introduce workaround for admonition icons of MkDocs.
2aab54319: TechDocs: links at sidebar and bottom reset scroll position to top
Updated dependencies [01ccef4c7]
Updated dependencies [fcc3ada24]
Updated dependencies [4618774ff]
Updated dependencies [df59930b3]

0.6.2

Patch Changes

83bfc98a3: On TechDocs page header, change the breadcrumbs link to be static and point to TechDocs homepage.
e7baa0d2e: Separate techdocs-backend and frontend config schema declarations
c8b54c370: Extended TechDocs HomePage with owned documents
Updated dependencies [0434853a5]
Updated dependencies [8686eb38c]
Updated dependencies [9ca0e4009]
Updated dependencies [34ff49b0f]
Updated dependencies [8686eb38c]
Updated dependencies [424742dc1]
Updated dependencies [4e0b5055a]

0.6.1

Patch Changes

aa095e469: OpenStack Swift publisher added for tech-docs.
2089de76b: Make use of the new core ItemCardGrid and ItemCardHeader instead of the deprecated ItemCard.
868e4cdf2: - Adds a link to the owner entity
- Corrects the link to the component which includes the namespace
ca4a904f6: Add an optional configuration option for setting the url endpoint for AWS S3 publisher: techdocs.publisher.awsS3.endpoint
Updated dependencies [d7245b733]
Updated dependencies [0b42fff22]
Updated dependencies [0b42fff22]
Updated dependencies [2ef5bc7ea]
Updated dependencies [ff4d666ab]
Updated dependencies [aa095e469]
Updated dependencies [2089de76b]
Updated dependencies [dc1fc92c8]
Updated dependencies [bc46435f5]
Updated dependencies [a501128db]
Updated dependencies [ca4a904f6]

0.6.0

Minor Changes

813c6a4f2: Add authorization header on techdocs api requests. Breaking change as clients now needs the Identity API.

Patch Changes

Updated dependencies [12d8f27a6]
Updated dependencies [f43192207]
Updated dependencies [40c0fdbaa]
Updated dependencies [2a271d89e]
Updated dependencies [bece09057]
Updated dependencies [169f48deb]
Updated dependencies [8a1566719]
Updated dependencies [9d455f69a]
Updated dependencies [4c049a1a1]
Updated dependencies [02816ecd7]
Updated dependencies [61299519f]

0.5.8

Patch Changes

f37992797: Got rid of some attr and cleaned up a bit in the TechDocs config schema.
2499f6cde: Add support for assuming role in AWS integrations
Updated dependencies [3a58084b6]
Updated dependencies [e799e74d4]
Updated dependencies [dc12852c9]
Updated dependencies [d0760ecdf]
Updated dependencies [1407b34c6]
Updated dependencies [88f1f1b60]
Updated dependencies [bad21a085]
Updated dependencies [9615e68fb]
Updated dependencies [49f9b7346]
Updated dependencies [5c2e2863f]
Updated dependencies [3a58084b6]
Updated dependencies [2499f6cde]
Updated dependencies [a1f5e6545]
Updated dependencies [1e4ddd71d]
Updated dependencies [2c1f2a7c2]

0.5.7

Patch Changes

Updated dependencies [fd3f2a8c0]
Updated dependencies [fb28da212]
Updated dependencies [d34d26125]
Updated dependencies [0af242b6d]
Updated dependencies [f4c2bcf54]
Updated dependencies [10a0124e0]
Updated dependencies [07e226872]
Updated dependencies [26e143e60]
Updated dependencies [c6655413d]
Updated dependencies [44414239f]
Updated dependencies [b0a41c707]
Updated dependencies [f62e7abe5]
Updated dependencies [96f378d10]
Updated dependencies [688b73110]

0.5.6

Patch Changes

f5e564cd6: Improve display of error messages
41af18227: Migrated to new composability API, exporting the plugin instance as techdocsPlugin, the top-level page as TechdocsPage, and the entity content as EntityTechdocsContent.
8f3443427: Enhance API calls to support trapping 500 errors from techdocs-backend
Updated dependencies [77ad0003a]
Updated dependencies [b51ee6ece]
Updated dependencies [19d354c78]
Updated dependencies [08142b256]
Updated dependencies [08142b256]
Updated dependencies [b51ee6ece]

0.5.5

Patch Changes

5fa3bdb55: Add href in addition to onClick to ItemCard. Ensure that the height of a ItemCard with and without tags is equal.
e44925723: techdocs.requestUrl and techdocs.storageUrl are now optional configs and the discovery API will be used to get the URL where techdocs plugin is hosted.
019fe39a0: Switch dependency from @backstage/plugin-catalog to @backstage/plugin-catalog-react.
Updated dependencies [c777df180]
Updated dependencies [12ece98cd]
Updated dependencies [d82246867]
Updated dependencies [7fc89bae2]
Updated dependencies [c810082ae]
Updated dependencies [5fa3bdb55]
Updated dependencies [6e612ce25]
Updated dependencies [e44925723]
Updated dependencies [025e122c3]
Updated dependencies [21e624ba9]
Updated dependencies [da9f53c60]
Updated dependencies [32c95605f]
Updated dependencies [7881f2117]
Updated dependencies [f0320190d]
Updated dependencies [54c7d02f7]
Updated dependencies [11cb5ef94]

0.5.4

Patch Changes

a5e27d5c1: Create type for TechDocsMetadata (#3716)

This change introduces a new type (TechDocsMetadata) in packages/techdocs-common. This type is then introduced in the endpoint response in techdocs-backend and in the api interface in techdocs (frontend).
Updated dependencies [def2307f3]
Updated dependencies [efd6ef753]
Updated dependencies [593632f07]
Updated dependencies [33846acfc]
Updated dependencies [a187b8ad0]
Updated dependencies [f04db53d7]
Updated dependencies [53c9c51f2]
Updated dependencies [a5e27d5c1]
Updated dependencies [a93f42213]

0.5.3

Patch Changes

dbe4450c3: Google Cloud authentication in TechDocs has been improved.
1. techdocs.publisher.googleGcs.credentials is now optional. If it is missing, GOOGLE_APPLICATION_CREDENTIALS environment variable (and some other methods) will be used to authenticate. Read more here https://cloud.google.com/docs/authentication/production
2. techdocs.publisher.googleGcs.projectId is no longer used. You can remove it from your app-config.yaml.
a6f9dca0d: Remove dependency on @backstage/core-api. No plugin should ever depend on that package; it's an internal concern whose important bits are re-exported by @backstage/core which is the public facing dependency to use.
b3b9445df: AWS S3 authentication in TechDocs has been improved.
1. techdocs.publisher.awsS3.bucketName is now the only required config. techdocs.publisher.awsS3.credentials and techdocs.publisher.awsS3.region are optional.
2. If techdocs.publisher.awsS3.credentials and techdocs.publisher.awsS3.region are missing, the AWS environment variables AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_REGION will be used. There are more better ways of setting up AWS authentication. Read the guide at https://backstage.io/docs/features/techdocs/using-cloud-storage
e5d12f705: Use history.pushState for hash link navigation.
Updated dependencies [68ad5af51]
Updated dependencies [f3b064e1c]
Updated dependencies [371f67ecd]
Updated dependencies [f1e74777a]
Updated dependencies [dbe4450c3]
Updated dependencies [c00488983]
Updated dependencies [265a7ab30]
Updated dependencies [5826d0973]
Updated dependencies [b3b9445df]
Updated dependencies [abbee6fff]
Updated dependencies [147fadcb9]

0.5.2

Patch Changes

359f9d2d8: Added configuration schema for the commonly used properties of techdocs and techdocs-backend plugins
Updated dependencies [a08c32ced]
Updated dependencies [7e0b8cac5]
Updated dependencies [8804e8981]
Updated dependencies [87c0c53c2]
Updated dependencies [86c3c652a]
Updated dependencies [27f2af935]

0.5.1

Patch Changes

Updated dependencies [d681db2b5]
Updated dependencies [1dc445e89]
Updated dependencies [342270e4d]
Updated dependencies [1dc445e89]
Updated dependencies [a8573e53b]

0.5.0

Minor Changes

dae4f3983: Breaking changes
1. Added option to use Google Cloud Storage as a choice to store the static generated files for TechDocs. It can be configured using techdocs.publisher.type option in app-config.yaml. Step-by-step guide to configure GCS is available here https://backstage.io/docs/features/techdocs/using-cloud-storage Set techdocs.publisher.type to 'local' if you want to continue using local filesystem to store TechDocs files.
2. techdocs.builder is now required and can be set to 'local' or 'external'. (Set it to 'local' for now, since CI/CD build workflow for TechDocs will be available soon (in few weeks)). If builder is set to 'local' and you open a TechDocs page, techdocs-backend will try to generate the docs, publish to storage and show the generated docs afterwords. If builder is set to 'external', techdocs-backend will only fetch the docs and will NOT try to generate and publish. In this case of 'external', we assume that docs are being built in the CI/CD pipeline of the repository. TechDocs will not assume a default value for techdocs.builder. It is better to explicitly define it in the app-config.yaml.
3. When configuring TechDocs in your backend, there is a difference in how a new publisher is created.
```
---  const publisher = new LocalPublish(logger, discovery);
+++  const publisher = Publisher.fromConfig(config, logger, discovery);
```
Based on the config techdocs.publisher.type, the publisher could be either Local publisher or Google Cloud Storage publisher.
1. techdocs.storageUrl is now a required config. Should be http://localhost:7000/api/techdocs/static/docs in most setups.
2. Parts of @backstage/plugin-techdocs-backend have been moved to a new package @backstage/techdocs-common to generate docs. Also to publish docs to-and-fro between TechDocs and a storage (either local or external). However, a Backstage app does NOT need to import the techdocs-common package - app should only import @backstage/plugin-techdocs and @backstage/plugin-techdocs-backend.
Patch changes
1. See all of TechDocs config options and its documentation https://backstage.io/docs/features/techdocs/configuration
2. Logic about serving static files and metadata retrieval have been abstracted away from the router in techdocs-backend to the instance of publisher.
3. Removed Material UI Spinner from TechDocs header. Spinners cause unnecessary UX distraction. Case 1 (when docs are built and are to be served): Spinners appear for a split second before the name of site shows up. This unnecessarily distracts eyes because spinners increase the size of the Header. A dot (.) would do fine. Definitely more can be done. Case 2 (when docs are being generated): There is already a linear progress bar (which is recommended in Storybook).

Patch Changes

Updated dependencies [c911061b7]
Updated dependencies [dae4f3983]
Updated dependencies [8ef71ed32]
Updated dependencies [0e6298f7e]
Updated dependencies [7dd2ef7d1]
Updated dependencies [ac3560b42]

0.4.0

Minor Changes

87a33d2fe: Removed modifyCss transformer and moved the css to injectCss transformer Fixed issue where some internal doc links would cause a reload of the page

Patch Changes

Updated dependencies [b6557c098]
Updated dependencies [2527628e1]
Updated dependencies [6011b7d3e]
Updated dependencies [e1f4e24ef]
Updated dependencies [1c69d4716]
Updated dependencies [d8d5a17da]
Updated dependencies [83b6e0c1f]
Updated dependencies [1665ae8bb]
Updated dependencies [04f26f88d]
Updated dependencies [ff243ce96]

0.3.1

Patch Changes

da2ad65cb: Use type EntityName from catalog-model for entities
Updated dependencies [b4488ddb0]
Updated dependencies [08835a61d]
Updated dependencies [a9fd599f7]
Updated dependencies [bcc211a08]
Updated dependencies [ebf37bbae]

0.3.0

Minor Changes

4b53294a6: - Use techdocs annotation to add repo_url if missing in mkdocs.yml. Having repo_url creates a Edit button on techdocs pages.
- techdocs-backend: API endpoint /metadata/mkdocs/* renamed to /metadata/techdocs/*

Patch Changes

Updated dependencies [6f70ed7a9]
Updated dependencies [ab94c9542]
Updated dependencies [2daf18e80]
Updated dependencies [069cda35f]
Updated dependencies [700a212b4]

0.2.3

Patch Changes

Updated dependencies [475fc0aaa]
Updated dependencies [1166fcc36]
Updated dependencies [1185919f3]

0.2.2

Patch Changes

1722cb53c: Added configuration schema
Updated dependencies [1722cb53c]
Updated dependencies [8b7737d0b]

0.2.1

Patch Changes

Updated dependencies [c5bab94ab]
Updated dependencies [7b37d65fd]
Updated dependencies [4aca74e08]
Updated dependencies [e8f69ba93]
Updated dependencies [0c0798f08]
Updated dependencies [0c0798f08]
Updated dependencies [199237d2f]
Updated dependencies [6627b626f]
Updated dependencies [4577e377b]
Updated dependencies [2d0bd1be7]

0.2.0

Minor Changes

28edd7d29: Create backend plugin through CLI
8351ad79b: Add a message if techdocs takes long time to load

Fixes #2416.

The UI after the change should look like this:

Patch Changes

782f3b354: add test case for Progress component
57b54c8ed: While techdocs fetches site name and metadata for the component, the page title was displayed as '[object Object] | Backstage'. This has now been fixed to display the component ID if site name is not present or being fetched.
Updated dependencies [28edd7d29]
Updated dependencies [819a70229]
Updated dependencies [3a4236570]
Updated dependencies [ae5983387]
Updated dependencies [0d4459c08]
Updated dependencies [cbbd271c4]
Updated dependencies [482b6313d]
Updated dependencies [e0be86b6f]
Updated dependencies [f70a52868]
Updated dependencies [12b5fe940]
Updated dependencies [368fd8243]
Updated dependencies [1c60f716e]
Updated dependencies [144c66d50]
Updated dependencies [a768a07fb]
Updated dependencies [b79017fd3]
Updated dependencies [6d97d2d6f]
Updated dependencies [5adfc005e]
Updated dependencies [f0aa01bcc]
Updated dependencies [0aecfded0]
Updated dependencies [93a3fa3ae]
Updated dependencies [782f3b354]
Updated dependencies [8b9c8196f]
Updated dependencies [2713f28f4]
Updated dependencies [406015b0d]
Updated dependencies [82759d3e4]
Updated dependencies [60d40892c]
Updated dependencies [ac8d5d5c7]
Updated dependencies [2ebcfac8d]
Updated dependencies [fa56f4615]
Updated dependencies [ebca83d48]
Updated dependencies [aca79334f]
Updated dependencies [c0d5242a0]
Updated dependencies [b3d57961c]
Updated dependencies [0b956f21b]
Updated dependencies [26e69ab1a]
Updated dependencies [97c2cb19b]
Updated dependencies [3beb5c9fc]
Updated dependencies [cbab5bbf8]
Updated dependencies [754e31db5]
Updated dependencies [1611c6dbc]
- @backstage/plugin-catalog@0.2.0
- @backstage/core-api@0.2.0
- @backstage/core@0.2.0
- @backstage/catalog-model@0.2.0
- @backstage/theme@0.2.0
- @backstage/test-utils@0.1.2