API/vike-plugin-typedoc/buildMarkdownProcessor

buildMarkdownProcessor

function
function buildMarkdownProcessor(
  rehypeTypedocOptions?: RehypeTypedocOptions,
  remarkPlugins: PluggableList,
  rehypePlugins: PluggableList
): MarkdownProcessor;

Build a unified processor for rendering markdown to HTML.

The pipeline is:
remarkParse -> remarkGfm -> remarkBreaks -> remarkDirective -> remarkCodeProps -> [user remarkPlugins]
-> remarkRehype -> [rehypeTypedoc] -> [user rehypePlugins]
-> [rehypeTypedocCodeBlocks] -> rehypeStringify

If no rehype-typedoc options are provided, the typedoc plugins are skipped.

PARAMETERS

NAMETYPEDESCRIPTION
rehypeTypedocOptions?RehypeTypedocOptions—
remarkPluginsPluggableList—
rehypePluginsPluggableList—

RETURNS

MarkdownProcessor