renderMdxProse

Render markdown block text (a description, remarks, or module overview) as MDX-safe markdown. Fenced code blocks are re-emitted verbatim (surrounded by blank lines, with a language); prose segments have their inline link tags resolved and their MDX-unsafe characters escaped.

Import:

import { renderMdxProse } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-link-rendering';

Signature:

function renderMdxProse(text: string, allTypes: Map<string, TypeInfo>, selfNamespace: string | undefined): string

Parameters:

Parameter	Type	Description
text	string	The text.
allTypes	Map<string, TypeInfo>	Every documented type, keyed by $\{namespace\}#$\{name\}.
selfNamespace	string | undefined	The namespace of the page being rendered, preferred when a name is ambiguous.

Returns: string — The MDX.

---

Links to this page:

• renderExampleMdx