md2docx()

Defined in: packages/cli/src/shared.ts:26

Converts Markdown to DOCX in Node.js using @m2d/remark-docx-node with native image and Mermaid rasterization.

Type ParametersCopy Anchor Link

TCopy Anchor Link

T extends keyof OutputByType = "nodebuffer"

ParametersCopy Anchor Link

mdCopy Anchor Link

string

Markdown string input

docxProps?Copy Anchor Link

IDocxProps = {}

Global document properties passed to @m2d/core

sectionProps?Copy Anchor Link

Optional<IDefaultMdastToDocxSectionProps>

Default section properties (page size, margins, plugins)

outputType?Copy Anchor Link

T = ...

Desired DOCX output format ("nodebuffer" by default on Node)

pluginProps?Copy Anchor Link

Mdast2DocxNodePluginProps

Configurations for sub-plugins (nodeImage, nodeMermaid, list, table, emoji)

ReturnsCopy Anchor Link

Promise<OutputByType[T]>

The generated DOCX output