Skip to content

buildBacklinksFromContent

Build backlinks by scanning generated page content for internal API links. Keyed by qualified id.

Import:

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

Signature:

function buildBacklinksFromContent(pageContents: Map<string, PageContent>, allTypes: Map<string, TypeInfo>): Map<string, string[]>

Parameters:

Parameter Type Description
pageContents Map<string, PageContent> Every overview page’s content and path, keyed by qualified id.
allTypes Map<string, TypeInfo> Every documented type, keyed by $\{namespace\}#$\{name\}.

Returns: Map<string, string[]> — Each referenced type’s qualified id mapped to the ids of the pages linking to it.