Skip to main content

defaults

Default formatter implementations shared across multiple formatter packages.

These functions provide the standard/baseline rendering behaviour. Individual formatters import what they need and override only what differs.

formatMDXAdmonition()​

function formatMDXAdmonition(admonition, _meta): MDXString;

Defined in: defaults.ts:42

Formats an admonition as an HTML <fieldset> element with gqlmd-mdx-admonition-* CSS classes.

Parameters​

admonition​

AdmonitionType

Admonition data with text, title, type, and optional icon

_meta​

Maybe<MetaInfo>

Unused metadata parameter

Returns​

MDXString

Formatted admonition string

formatMDXBadge()​

function formatMDXBadge(badge): MDXString;

Defined in: defaults.ts:32

Formats a badge using an HTML <mark> element with a gqlmd-mdx-badge CSS class.

Parameters​

badge​

Badge

Badge data containing the text to display

Returns​

MDXString

Formatted badge string

formatMDXBullet()​

function formatMDXBullet(text?): MDXString;

Defined in: defaults.ts:54

Formats a bullet point separator using a <span> with a gqlmd-mdx-bullet CSS class.

Parameters​

text?​

string = ""

Optional text to append after the bullet

Returns​

MDXString

Formatted bullet string

formatMDXDetails()​

function formatMDXDetails(option): MDXString;

Defined in: defaults.ts:64

Formats a collapsible block as an HTML <details> element with a gqlmd-mdx-details CSS class. The summary label is uppercase; the close label is rendered as <em>.

Parameters​

option​

CollapsibleOption

Configuration for open/close label text

Returns​

MDXString

Formatted details element string

formatMDXFrontmatter()​

function formatMDXFrontmatter(_props, formatted): MDXString;

Defined in: defaults.ts:77

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

function formatMDXLink(link): TypeLink;

Defined in: defaults.ts:93

Formats a type link — returns the link unchanged (identity passthrough).

Parameters​

TypeLink

The TypeLink object to format

Returns​

TypeLink

The unmodified TypeLink object

formatMDXNameEntity()​

function formatMDXNameEntity(name, parentType?): MDXString;

Defined in: defaults.ts:103

Formats a named entity using <span> and <code> elements with gqlmd-mdx-entity-* CSS classes.

Parameters​

name​

string

Entity name

parentType?​

Maybe<string>

Optional parent type name for qualified references

Returns​

MDXString

Formatted entity reference string

function formatMDXSpecifiedByLink(url): MDXString;

Defined in: defaults.ts:119

Formats a "specified by" link as an HTML <span> with a gqlmd-mdx-specifiedby CSS class containing an anchor that opens in a new tab.

Parameters​

url​

string

URL to the specification

Returns​

MDXString

Formatted specification link string