mdast2docx logo Md2Docx
Version 0.1.1API DocsVariables

remarkDocx

Updated 22 Oct 2026

const remarkDocx: Plugin<[outputType?: OutputType, docxProps?: IDocxProps, sectionProps?: ISectionProps, pluginProps?: Mdast2DocxNodePluginProps], Root>

Defined in: index.ts:34

A unified compiler plugin to convert MDAST to DOCX on Node.js using mdast2docx/plugins/node. Automatically configures nodeHtmlPlugin, nodeImagePlugin, and nodeMermaidPlugin for server-side rasterization and parsing.

Param

outputType

The output type for DOCX generation (e.g. "blob", "buffer", "base64"). Defaults to "blob".

Param

docxProps

Global DOCX document properties passed to toDocx. Optional.

Param

sectionProps

Section-level props including plugin overrides. Optional.

Param

pluginProps

Configurations for node plugins (nodeHtml, nodeMermaid, list, table, emoji, nodeImage).

Returns

A unified plugin that injects a DOCX compiler.

On this page