Skip to main content
Version: Next

@backstage/plugin-techdocs

Home > @backstage/plugin-techdocs

The Backstage plugin that renders technical documentation for your components

Classes

Class

Description

TechDocsClient

API to talk to techdocs-backend.

TechDocsStorageClient

API which talks to TechDocs storage to fetch files to render.

Functions

Function

Description

DefaultTechDocsHome(props)

Component which renders a default documentation landing page.

DocsCardGrid(props)

Component which accepts a list of entities and renders a item card for each entity

EmbeddedDocsRouter(props)

Responsible for registering route to view docs on Entity page

EntityListDocsGrid(props)

Component responsible to get entities from entity list context and pass down to DocsCardGrid

EntityTechdocsContent(props)

Routable extension used to render docs on Entity page

isTechDocsAvailable(entity)

Helper that takes in entity and returns true/false if TechDocs is available for the entity

Reader(props)

Component responsible for rendering TechDocs documentation

Router()

Responsible for registering routes for TechDocs, TechDocs Homepage and separate TechDocs page

TechDocsCustomHome(props)

Component which takes a custom tabs config object and renders a documentation landing page.

TechDocsIndexPage(props)

Responsible for rendering the provided router element

TechdocsPage()

Routable extension used to render docs

TechDocsPageWrapper(props)

Component wrapping a TechDocs page with Page and Header components

TechDocsPicker()

Component responsible for updating TechDocs filters

TechDocsReaderLayout(props)

Default TechDocs reader page structure composed with a header and content

TechDocsReaderPage(props)

Component responsible for composing a TechDocs reader page experience

TechDocsReaderPageContent(props)

Renders the reader page content

TechDocsReaderPageHeader(props)

Renders the reader page header. This component does not accept props, please use the Tech Docs add-ons to customize it

TechDocsReaderPageSubheader(props)

Renders the reader page subheader. Please use the Tech Docs add-ons to customize it

TechDocsReaderProvider(props)

Provides shared building process state to the reader page components.

TechDocsSearch(props)

Component used to render search bar on TechDocs page, scoped to

TechDocsSearchResultListItem(props)

React extension used to render results on Search page or modal

Interfaces

Interface

Description

PanelConfig

Type representing a TechDocsCustomHome panel.

TabConfig

Type representing a TechDocsCustomHome tab.

TechDocsApi

API to talk to techdocs-backend.

TechDocsStorageApi

API which talks to TechDocs storage to fetch files to render.

Variables

Variable

Description

DocsTable

Component which renders a table documents

EntityListDocsTable

Component which renders a table with entities from catalog.

techdocsApiRef

Utility API reference for the TechDocsApi.

techdocsPlugin

The Backstage plugin that renders technical documentation for your components

techdocsStorageApiRef

Utility API reference for the TechDocsStorageApi.

Type Aliases

Type Alias

Description

ContentStateTypes

A state representation that is used to configure the UI of

DefaultTechDocsHomeProps

Props for DefaultTechDocsHome()

DocsCardGridProps

Props for DocsCardGrid()

DocsGroupConfig

Props for EntityListDocsGrid()

DocsTableProps

Props for DocsTable.

DocsTableRow

Generic representing the metadata structure for a docs table row.

EntityListDocsGridPageProps

Props for EntityListDocsGrid()

EntityListDocsTableProps

Props for EntityListDocsTable.

PanelType

Available panel types

ReaderState

shared reader state

SyncResult

The outcome of a docs sync operation.

TabsConfig

Type representing a list of TechDocsCustomHome tabs.

TechDocsCustomHomeProps

Props for TechDocsCustomHome()

TechDocsEntityMetadata

TechDocsIndexPageProps

Props for TechDocsIndexPage()

TechDocsMetadata

TechDocsPageWrapperProps

Props for TechDocsPageWrapper()

TechDocsReaderLayoutProps

Props for TechDocsReaderLayout()

TechDocsReaderPageContentProps

Props for TechDocsReaderPageContent()

TechDocsReaderPageHeaderProps

Props for TechDocsReaderPageHeader()

TechDocsReaderPageProps

TechDocsReaderPageRenderFunction

Helper function that gives the children of TechDocsReaderPage() access to techdocs and entity metadata

TechDocsReaderProviderProps

Props for TechDocsReaderProvider()

TechDocsReaderProviderRenderFunction

Render function for TechDocsReaderProvider()

TechDocsSearchProps

Props for TechDocsSearch()

TechDocsSearchResultListItemProps

Props for TechDocsSearchResultListItem().