Skip to main content

docfx

DocFX formatter for GraphQL documentation output.

Produces Markdown compatible with Microsoft DocFX. Uses DocFX alert syntax for admonitions and injects the required uid front matter field for cross-reference resolution.

afterRenderTypeEntitiesHook​

const afterRenderTypeEntitiesHook: RenderTypeEntitiesHook;

Defined in: docfx/index.ts:200

Builds DocFX toc.yml navigation files as each entity page is written.

Walks up from the generated file to the graphql output root (outputDir), writing or updating a toc.yml at every directory level. Section index pages are prepended as an "Overview" entry on first encounter.

BADGE_CLASS_MAP​

const BADGE_CLASS_MAP: Record<string, string>;

Defined in: docfx/index.ts:54

Maps graphql-markdown badge classnames to Bootstrap 5 contextual badge classes.

mdxExtension​

const mdxExtension: ".md";

Defined in: docfx/index.ts:148

createMDXFormatter()​

function createMDXFormatter(_meta?): Formatter;

Defined in: docfx/index.ts:135

Creates a DocFX formatter.

Parameters​

_meta?​

Maybe<MetaInfo>

Unused metadata parameter

Returns​

Formatter

A complete Formatter implementation for DocFX output

formatMDXAdmonition()​

function formatMDXAdmonition(admonition, _meta): MDXString;

Defined in: docfx/index.ts:77

Formats an admonition using DocFX alert syntax (> [!TYPE]).

Parameters​

admonition​

AdmonitionType

Admonition data with text, title, and type

_meta​

Maybe<MetaInfo>

Unused metadata parameter

Returns​

MDXString

Formatted admonition string

formatMDXBadge()​

function formatMDXBadge(badge): MDXString;

Defined in: docfx/index.ts:65

Formats a badge using Bootstrap 5 badge classes available in DocFX's modern template.

Parameters​

badge​

Badge

Badge data containing text and optional classname

Returns​

MDXString

Formatted badge string

formatMDXFrontmatter()​

function formatMDXFrontmatter(props, formatted): MDXString;

Defined in: docfx/index.ts:93

Formats YAML front matter, injecting a uid field required by DocFX for cross-reference resolution between pages.

Parameters​

props​

Maybe<FrontMatterOptions>

Front matter options; id is used as the DocFX uid value

formatted​

Maybe<string[]>

Pre-formatted front matter lines

Returns​

MDXString

Formatted front matter block, or empty string if no lines provided

function formatMDXLink(link): TypeLink;

Defined in: docfx/index.ts:119

Returns the link unchanged — DocFX resolves .md links natively.

Parameters​

TypeLink

Link data with URL and text

Returns​

TypeLink

The link unchanged