Backstage
    Preparing search index...

    Module index

    The Backstage plugin that renders technical documentation for your components

    Classes

    TechDocsClient
    TechDocsStorageClient

    Interfaces

    PanelConfig
    PanelProps
    TabConfig
    TechDocsApi
    TechDocsStorageApi

    Type Aliases

    BackstageOverrides
    CatalogReactComponentsNameToClassKey
    ContentStateTypes
    DefaultTechDocsHomeProps
    DocsCardGridProps
    DocsGroupConfig
    DocsTableProps
    DocsTableRow
    EntityListDocsGridPageProps
    EntityListDocsTableProps
    InfoCardGridClassKey
    InfoCardGridProps
    PanelType
    ReaderState
    SyncResult
    TabsConfig
    TechDocsCustomHomeProps
    TechDocsEntityMetadata
    TechDocsIndexPageProps
    TechDocsMetadata
    TechDocsPageWrapperProps
    TechDocsReaderLayoutProps
    TechDocsReaderPageContentProps
    TechDocsReaderPageHeaderProps
    TechDocsReaderPageProps
    TechDocsReaderPageRenderFunction
    TechDocsReaderProviderProps
    TechDocsReaderProviderRenderFunction
    TechDocsSearchProps
    TechDocsSearchResultListItemProps

    Variables

    EntityTechdocsContent
    plugin
    Reader
    techdocsApiRef
    TechDocsCustomHome
    TechDocsIndexPage
    TechdocsPage
    TechDocsReaderPage
    TechDocsReaderPageContent
    TechDocsSearchResultListItem
    techdocsStorageApiRef

    Functions

    CustomDocsPanel
    DefaultTechDocsHome
    DocsCardGrid
    DocsTable
    EmbeddedDocsRouter
    EntityListDocsGrid
    EntityListDocsTable
    InfoCardGrid
    isTechDocsAvailable
    Router
    TechDocsPageWrapper
    TechDocsPicker
    TechDocsReaderLayout
    TechDocsReaderPageHeader
    TechDocsReaderPageSubheader
    TechDocsReaderProvider
    TechDocsSearch

    References

    techdocsPlugin → plugin

    Settings

    Member Visibility

    On This Page

    Classes
    Interfaces
    Type Aliases
    Variables
    Functions
    References