mdx

MDX formatting module for GraphQL-Markdown.

This module provides a set of utility functions for formatting various MDX components used in the documentation generation process. It handles the formatting of badges, admonitions, bullet points, collapsible sections, and other MDX-specific elements.

The module can be used with default formatters or customized with user-provided MDX formatting functions through the mdxModule factory function.

default

const default: MDXSupportType;

Defined in: mdx/index.ts:197

---

mdxDeclaration

const mdxDeclaration: "" = "";

Defined in: mdx/index.ts:195

---

mdxModule()

function mdxModule(mdxPackage?): Promise<Readonly<MDXSupportType>>

Defined in: mdx/index.ts:208

Parameters

mdxPackage?

Record<string, unknown>

Returns

Promise<Readonly<MDXSupportType>>