md2docx()

Defined in: packages/md2docx/src/md2docx.ts:23

Converts a Markdown string into a DOCX document using Unified and @m2d/remark-docx. Optimized for client-side and browser environments. For server-side Node.js workflows with native image and diagram rendering, use @m2d/cli.

ParametersCopy Anchor Link

mdCopy Anchor Link

string

The Markdown string to convert.

docxProps?Copy Anchor Link

IDocxProps = {}

Document properties passed to @m2d/core.

sectionProps?Copy Anchor Link

Optional<IDefaultMdastToDocxSectionProps>

Default section properties (page size, margins, plugins).

outputType?Copy Anchor Link

keyof OutputByType = "blob"

Desired DOCX output format ("blob", "buffer", "base64", etc.). Default: "blob".

pluginProps?Copy Anchor Link

Mdast2DocxPluginProps

Configurations for sub-plugins (mermaid, emoji, list, table, image).

ReturnsCopy Anchor Link

Promise<unknown>

The generated DOCX output in the requested format.