generateOverviewPage

Renders a type’s overview page.

Import:

import { generateOverviewPage } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-page-generation';

Signature:

function generateOverviewPage(name: string, info: TypeInfo, allTypes: Map<string, TypeInfo>): Promise<PageContent>

Parameters:

Parameter	Type	Description
name	string	The type’s name.
info	TypeInfo	The documented type.
allTypes	Map<string, TypeInfo>	Every documented type, keyed by $\{namespace\}#$\{name\}.

Returns: Promise<PageContent> — The page’s content, before backlinks, and the path it is written to.