Skip to main content

EmbeddedDocsRouter()

Home > @backstage/plugin-techdocs > EmbeddedDocsRouter

Responsible for registering route to view docs on Entity page

Signature:

LegacyEmbeddedDocsRouter: ({ children, withSearch, }: React.PropsWithChildren<{
    withSearch?: boolean | undefined;
}>) => React.JSX.Element

Parameters​

Parameter

Type

Description

{ children, withSearch, }

React.PropsWithChildren<{ withSearch?: boolean | undefined; }>
**Returns:**

React.JSX.Element