docusaurus
Docusaurus MDX formatter for GraphQL documentation output.
Produces MDX markup compatible with Docusaurus v2 and v3, using Badge, Bullet, SpecifiedBy components and native admonition syntax.
mdxDeclaration
const mdxDeclaration: MDXString;
Defined in: docusaurus/index.ts:43
MDX component definitions prepended to every generated file.
createMDXFormatter()
function createMDXFormatter(meta?): Formatter;
Defined in: docusaurus/index.ts:201
Creates a Docusaurus formatter.
Captures meta in closure so formatMDXAdmonition can detect the Docusaurus version.
Parameters
meta?
Maybe<MetaInfo>
Optional metadata used to detect Docusaurus version
Returns
Formatter
A complete Formatter implementation for Docusaurus MDX output
formatMDXAdmonition()
function formatMDXAdmonition(admonition, meta): MDXString;
Defined in: docusaurus/index.ts:72
Formats an admonition using Docusaurus native :::type callout syntax.
Detects Docusaurus v2 (via meta) and uses :::caution instead of :::warning.
Parameters
admonition
AdmonitionType
Admonition data with text, title, and type
meta
Maybe<MetaInfo>
Optional metadata used to detect Docusaurus version
Returns
MDXString
Formatted admonition string
formatMDXBadge()
function formatMDXBadge(badge): MDXString;
Defined in: docusaurus/index.ts:59
Formats a badge using the inline <Badge> component defined in mdxDeclaration.
Appends a CSS class derived from classname (e.g. badge--deprecated).
Parameters
badge
Badge
Badge data containing text and optional classname
Returns
MDXString
Formatted Badge component string
formatMDXBullet()
function formatMDXBullet(text?): MDXString;
Defined in: docusaurus/index.ts:90
Formats a bullet point using the inline <Bullet/> component defined in mdxDeclaration.
Parameters
text?
string = ""
Optional text to append after the bullet
Returns
MDXString
Formatted Bullet component string
formatMDXDetails()
function formatMDXDetails(option): MDXString;
Defined in: docusaurus/index.ts:101
Formats a collapsible block as an HTML <details> element with
toggle labels that swap via the hidden attribute.
Text is escaped so curly braces and angle brackets don't break MDX.
Parameters
option
CollapsibleOption
Configuration for open/close label text
Returns
MDXString
Formatted details element string
formatMDXFrontmatter()
function formatMDXFrontmatter(_props, formatted): MDXString;
Defined in: docusaurus/index.ts:153
Formats YAML front matter wrapped in --- delimiters.
Parameters
_props
Maybe<FrontMatterOptions>
Front matter options (unused)
formatted
Maybe<string[]>
Pre-formatted front matter lines
Returns
MDXString
Formatted front matter block, or empty string if no lines provided
formatMDXLink()
function formatMDXLink(link): TypeLink;
Defined in: docusaurus/index.ts:140
Appends .mdx to internal link URLs.
Parameters
link
TypeLink
Link data with URL and text
Returns
TypeLink
Link with .mdx extension appended to the URL
formatMDXNameEntity()
function formatMDXNameEntity(name, parentType?): MDXString;
Defined in: docusaurus/index.ts:127
Formats a named entity as an inline <code> element with the parent type
in normal weight and the entity name in bold.
Text is escaped so curly braces don't break MDX.
Parameters
name
string
Entity name
parentType?
Maybe<string>
Optional parent type name for qualified references
Returns
MDXString
Formatted JSX code element string
formatMDXPermalink()
function formatMDXPermalink(id, meta?): MDXString;
Defined in: docusaurus/index.ts:179
Formats a permalink for a section header.
Docusaurus 3.10 introduced a heading id syntax based on a native MDX comment, and deprecated the classic one. The braces of the comment must NOT be escaped: the heading id is extracted from a real MDX expression node, so an escaped token would be rendered as text. Older versions only support the classic syntax, whose braces must be escaped to remain valid MDX.
Parameters
id
string
The ID of the section header
meta?
Maybe<MetaInfo>
Optional metadata used to detect the Docusaurus version
Returns
MDXString
Formatted permalink string
See
https://docusaurus.io/blog/releases/3.10#strict-heading-ids
formatMDXSpecifiedByLink()
function formatMDXSpecifiedByLink(url): MDXString;
Defined in: docusaurus/index.ts:115
Formats a "specified by" link using the inline <SpecifiedBy> component.
Parameters
url
string
URL to the specification
Returns
MDXString
Formatted SpecifiedBy component string