docs-site/api-doc-page-generation

MDX page + sidebar emission: renders module index pages, per-type overview pages, per-member pages, backlinks, and the Starlight sidebar JSON.

Functions

Function	Description
appendBacklinksAndWrite	Append backlinks to overview pages and write all files. Keyed by qualified $\{namespace\}#$\{name\}.
buildBacklinksFromContent	Build backlinks by scanning generated page content for internal API links. Keyed by qualified id.
buildSidebarTree	Builds the namespace tree the sidebar is generated from.
computeOverviewSignature	The raw code signature shown on a type-overview page’s OG card, for the kinds that render a single signature line (function / type alias / variable). Classes, interfaces and enums render member tables instead, so they get no signature block.
generateMemberPages	Writes one page per own property and per own method overload key of a class or interface.
generateNamespaceIndexPages	Writes each module’s index page and the root API index.
generateOverviewPage	Renders a type’s overview page.
generateSidebarJson	Writes the Starlight sidebar of the API reference.
renderConstructorMdx	Renders a class’s constructor block.
renderEnumPage	Renders an enum’s members.
renderFrontMatter	Render the Starlight frontmatter block (through the closing --- and its blank line) shared by every generated page kind: module index, type overview, property, and method. Every page kind goes through here so no field can be emitted on some kinds and silently dropped on others. description in particular is not just SEO metadata — it is the line the OG card renders under the title, so a page kind that skipped it produced a title-only card next to fully populated ones.
renderFunctionPage	Renders a function’s signature, parameters, return value and examples.
renderMethodOverloadMdx	Renders one method overload.
renderMethodTableMdx	Renders a type’s method table.
renderPropertyTableMdx	Renders a type’s property table.
renderTypeAliasPage	Renders a type alias’s signature.
renderVariablePage	Renders a variable’s declaration and type.
sidebarTreeToEntries	Converts a namespace tree node into a sidebar group.