TechDocsStorageClient.getEntityDocs()
Home > @backstage/plugin-techdocs > TechDocsStorageClient > getEntityDocs
Fetch HTML content as text for an individual docs page in an entity's docs site.
Signature:
getEntityDocs(entityId: CompoundEntityRef, path: string): Promise<string>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| entityId | CompoundEntityRef | Object containing entity data like name, namespace, etc. |
| path | string | The unique path to an individual docs page e.g. overview/what-is-new |
Returns:
Promise<string>
HTML content of the docs page as string
Exceptions
Throws error when the page is not found.