Skip to main content

EmbeddedDocsRouter()

Home > @backstage/plugin-techdocs > EmbeddedDocsRouter

Responsible for registering route to view docs on Entity page

Signature:

LegacyEmbeddedDocsRouter: ({ children, withSearch, }: PropsWithChildren<{
    withSearch?: boolean;
}>) => import("react/jsx-runtime").JSX.Element

Parameters​

Parameter

Type

Description

{ children, withSearch, }

PropsWithChildren<{ withSearch?: boolean; }>
**Returns:**

import("react/jsx-runtime").JSX.Element