Skip to main content

fumadocs

Fumadocs formatter for GraphQL documentation output.

Produces MDX compatible with Next.js Fumadocs using its native Callout component for admonitions and Material UI Chip for badges.

mdxDeclaration​

const mdxDeclaration: MDXString;

Defined in: fumadocs/index.ts:33

MDX import statement prepended to every generated file to register Fumadocs and MUI components.

mdxExtension​

const mdxExtension: ".mdx";

Defined in: fumadocs/index.ts:30

File extension used for generated pages.

createMDXFormatter()​

function createMDXFormatter(_meta?): Formatter;

Defined in: fumadocs/index.ts:89

Creates a Fumadocs formatter.

Parameters​

_meta?​

Maybe<MetaInfo>

Unused metadata parameter

Returns​

Formatter

A complete Formatter implementation for Fumadocs MDX output

formatMDXAdmonition()​

function formatMDXAdmonition(admonition, _meta): MDXString;

Defined in: fumadocs/index.ts:56

Formats an admonition using the Fumadocs <Callout> component. Maps warning type to warn; all other types use info.

Parameters​

admonition​

AdmonitionType

Admonition data with text, title, and type

_meta​

Maybe<MetaInfo>

Unused metadata parameter

Returns​

MDXString

Formatted Fumadocs Callout component string

formatMDXBadge()​

function formatMDXBadge(badge): MDXString;

Defined in: fumadocs/index.ts:44

Formats a badge using the Material UI <Chip> component. Maps DEPRECATED classname to warning color; all others use info.

Parameters​

badge​

Badge

Badge data containing text and optional classname

Returns​

MDXString

Formatted MUI Chip component string

function formatMDXLink(link): TypeLink;

Defined in: fumadocs/index.ts:69

Appends .mdx to internal link URLs.

Parameters​

TypeLink

Link data with URL and text

Returns​

TypeLink

Link with .mdx extension appended to the URL