Skip to main content

format-helpers

Format event helpers for printer-legacy.

This module provides helper functions to emit MDX format events and handle fallback to default formatters when no custom handlers are registered.

formatMDXAdmonition()​

function formatMDXAdmonition(__namedParameters, _meta): MDXString;

Defined in: printer-legacy/src/format-helpers.ts:38

Default admonition formatter.

Parameters​

__namedParameters​

AdmonitionType

_meta​

Maybe<MetaInfo>

Returns​

MDXString

formatMDXBadge()​

function formatMDXBadge(badge): MDXString;

Defined in: printer-legacy/src/format-helpers.ts:31

Default badge formatter.

Parameters​

badge​

Badge

Returns​

MDXString

formatMDXBullet()​

function formatMDXBullet(text): MDXString;

Defined in: printer-legacy/src/format-helpers.ts:48

Default bullet formatter.

Parameters​

text​

string = ""

Returns​

MDXString

formatMDXDetails()​

function formatMDXDetails(__namedParameters): MDXString;

Defined in: printer-legacy/src/format-helpers.ts:55

Default details formatter.

Parameters​

__namedParameters​

CollapsibleOption

Returns​

MDXString

formatMDXFrontmatter()​

function formatMDXFrontmatter(_props, formatted): MDXString;

Defined in: printer-legacy/src/format-helpers.ts:64

Default frontmatter formatter.

Parameters​

_props​

Maybe<FrontMatterOptions>

formatted​

Maybe<string[]>

Returns​

MDXString

function formatMDXLink(link): TypeLink;

Defined in: printer-legacy/src/format-helpers.ts:78

Default link formatter.

Parameters​

TypeLink

Returns​

TypeLink

formatMDXNameEntity()​

function formatMDXNameEntity(name, parentType?): MDXString;

Defined in: printer-legacy/src/format-helpers.ts:85

Default name entity formatter.

Parameters​

name​

string

parentType?​

Maybe<string>

Returns​

MDXString

function formatMDXSpecifiedByLink(url): MDXString;

Defined in: printer-legacy/src/format-helpers.ts:98

Default specified-by link formatter.

Parameters​

url​

string

Returns​

MDXString