Skip to main content

mdbook

mdBook formatter for GraphQL documentation output.

Produces Markdown compatible with Rust's mdBook static site generator. Front matter is suppressed because mdBook renders it as literal content. Admonitions use mdBook's native > [!TYPE] syntax. Exports afterRenderFilesHook to build SUMMARY.md after all pages are written.

afterRenderFilesHook​

const afterRenderFilesHook: RenderFilesHook;

Defined in: mdbook/index.ts:164

Builds src/SUMMARY.md after all pages have been written.

mdBook requires every page to be listed in SUMMARY.md before the site can be built. This hook collects all rendered pages from the event, groups them by top-level section (Operations / Types) and category, then writes the file.

mdxExtension​

const mdxExtension: ".md" = ".md";

Defined in: mdbook/index.ts:101

mdBook expects .md files; override the default .mdx extension.

createMDXFormatter()​

function createMDXFormatter(_meta?): Formatter;

Defined in: mdbook/index.ts:131

Creates an mdBook formatter.

Parameters​

_meta?​

Maybe<MetaInfo>

Unused metadata parameter

Returns​

Formatter

A complete Formatter implementation for mdBook output

formatMDXAdmonition()​

function formatMDXAdmonition(admonition, _meta): MDXString;

Defined in: mdbook/index.ts:59

Formats an admonition using mdBook's native admonition syntax (> [!TYPE]). Uses type for the admonition tag and title as an optional override label.

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: mdbook/index.ts:48

Formats a badge as Markdown bold text — mdBook has no badge component.

Parameters​

badge​

Badge

Badge data containing text

Returns​

MDXString

Formatted bold text string

formatMDXDetails()​

function formatMDXDetails(option): MDXString;

Defined in: mdbook/index.ts:80

Renders a deprecated section as a bold inline label.

A fixed heading level would break hierarchy when this section is nested inside field entries at varying depths. Bold text is CommonMark-safe and works at any nesting level without affecting the heading outline.

The output is split on \r to produce [openSection, closeSection] as the printer expects — the deprecated items are inserted between the two halves.

Parameters​

option​

CollapsibleOption

Configuration for the section label

Returns​

MDXString

Bold label + split marker

formatMDXFrontmatter()​

function formatMDXFrontmatter(_props, formatted): MDXString;

Defined in: mdbook/index.ts:92

Replaces front matter with an H1 title heading. mdBook renders --- YAML blocks as literal content, so front matter is suppressed entirely. The page title is emitted as # Title instead.

Parameters​

_props​

Maybe<FrontMatterOptions>

formatted​

Maybe<string[]>

Returns​

MDXString

# Title\n when a title is available, otherwise an empty string

function formatMDXLink(link): TypeLink;

Defined in: mdbook/index.ts:108

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

Parameters​

TypeLink

Link data with URL and text

Returns​

TypeLink

The link with .md appended to extensionless absolute paths