@backstage/plugin-techdocs
Home > @backstage/plugin-techdocs
The Backstage plugin that renders technical documentation for your components
Classes
Class |
Description |
---|---|
API to talk to | |
API which talks to TechDocs storage to fetch files to render. |
Functions
Function |
Description |
---|---|
Component which renders a default documentation landing page. | |
Component which accepts a list of entities and renders a item card for each entity | |
Responsible for registering route to view docs on Entity page | |
Component responsible to get entities from entity list context and pass down to DocsCardGrid | |
Routable extension used to render docs on Entity page | |
Helper that takes in entity and returns true/false if TechDocs is available for the entity | |
Component responsible for rendering TechDocs documentation | |
Responsible for registering routes for TechDocs, TechDocs Homepage and separate TechDocs page | |
Component which takes a custom tabs config object and renders a documentation landing page. | |
Responsible for rendering the provided router element | |
Routable extension used to render docs | |
Component wrapping a TechDocs page with Page and Header components | |
Component responsible for updating TechDocs filters | |
Default TechDocs reader page structure composed with a header and content | |
Component responsible for composing a TechDocs reader page experience | |
Renders the reader page content | |
Renders the reader page header. This component does not accept props, please use the Tech Docs add-ons to customize it | |
Renders the reader page subheader. Please use the Tech Docs add-ons to customize it | |
Provides shared building process state to the reader page components. | |
Component used to render search bar on TechDocs page, scoped to | |
React extension used to render results on Search page or modal |
Interfaces
Interface |
Description |
---|---|
Type representing a TechDocsCustomHome panel. | |
Type representing a TechDocsCustomHome tab. | |
API to talk to techdocs-backend. | |
API which talks to TechDocs storage to fetch files to render. |
Variables
Variable |
Description |
---|---|
Component which renders a table documents | |
Component which renders a table with entities from catalog. | |
Utility API reference for the TechDocsApi. | |
The Backstage plugin that renders technical documentation for your components | |
Utility API reference for the TechDocsStorageApi. |
Type Aliases
Type Alias |
Description |
---|---|
A state representation that is used to configure the UI of | |
Props for DefaultTechDocsHome() | |
Props for DocsCardGrid() | |
Props for EntityListDocsGrid() | |
Props for DocsTable. | |
Generic representing the metadata structure for a docs table row. | |
Props for EntityListDocsGrid() | |
Props for EntityListDocsTable. | |
Available panel types | |
shared reader state | |
The outcome of a docs sync operation. | |
Type representing a list of TechDocsCustomHome tabs. | |
Props for TechDocsCustomHome() | |
Props for TechDocsIndexPage() | |
Props for TechDocsPageWrapper() | |
Props for TechDocsReaderLayout() | |
Props for TechDocsReaderPageContent() | |
Props for TechDocsReaderPageHeader() | |
Helper function that gives the children of TechDocsReaderPage() access to techdocs and entity metadata | |
Props for TechDocsReaderProvider() | |
Render function for TechDocsReaderProvider() | |
Props for TechDocsSearch() | |
Props for TechDocsSearchResultListItem(). |