API/vike-plugin-typedoc/renderExportMarkdown

renderExportMarkdown

function
function renderExportMarkdown(
  processor: MarkdownProcessor,
  comment: ApiComment | undefined,
  description: string | undefined,
  returnType: string | undefined
): Promise<RenderedExportMarkdown>;

Pre-render all markdown fields of an export's comment.

Note: Signature rendering is handled by the type-renderer pipeline,
not by the markdown processor.

  • summary is rendered as-is (inline markdown)
  • remarks is rendered as-is (block markdown)
  • Each example is wrapped in a typescript code fence before rendering
    (produces syntax-highlighted <pre><code> blocks)

PARAMETERS

NAMETYPEDESCRIPTION
processorMarkdownProcessor—
commentApiComment | undefined—
descriptionstring | undefined—
returnTypestring | undefined—

RETURNS