Skip to main content

mdx

formatMDXAdmonition()​

function formatMDXAdmonition(param, meta): MDXString

Defined in: mdx/index.ts:40

Formats an admonition block in MDX format

Parameters​

param​

AdmonitionType

The admonition configuration object

meta​

Maybe<MetaOptions>

Optional metadata for generator configuration

Returns​

MDXString

Formatted MDX string for the admonition

formatMDXBadge()​

function formatMDXBadge(__namedParameters): MDXString

Defined in: mdx/index.ts:28

Parameters​

__namedParameters​

Badge

Returns​

MDXString

formatMDXBullet()​

function formatMDXBullet(text): MDXString

Defined in: mdx/index.ts:57

Creates a bullet point element in MDX format

Parameters​

text​

string = ""

Optional text to append after the bullet point

Returns​

MDXString

Formatted MDX string for the bullet point

formatMDXDetails()​

function formatMDXDetails(param): MDXString

Defined in: mdx/index.ts:66

Creates a collapsible details section in MDX format

Parameters​

param​

CollapsibleOption

The collapsible section configuration

Returns​

MDXString

Formatted MDX string for the collapsible section

function formatMDXLink(__namedParameters): TypeLink

Defined in: mdx/index.ts:96

Parameters​

__namedParameters​

TypeLink

Returns​

TypeLink

formatMDXNameEntity()​

function formatMDXNameEntity(name, parentType?): MDXString

Defined in: mdx/index.ts:88

Formats a name entity with optional parent type

Parameters​

name​

string

The name to format

parentType?​

Maybe<string>

Optional parent type to prefix the name

Returns​

MDXString

Formatted MDX string for the name entity

function formatMDXSpecifiedByLink(url): MDXString

Defined in: mdx/index.ts:78

Creates a link to the specification documentation

Parameters​

url​

string

The URL to the specification

Returns​

MDXString

Formatted MDX string for the specification link