toDocx()

Defined in: packages/core/src/index.ts:29

Converts an MDAST (Markdown Abstract Syntax Tree) into a DOCX document.

ParametersCopy Anchor Link

astInputsCopy Anchor Link

IInputMDAST

A single or multiple MDAST trees with optional section properties.

docxProps?Copy Anchor Link

IDocxProps = {}

General document properties.

defaultSectionProps?Copy Anchor Link

ISectionProps = DEFAULT_SECTION_PROPS

Default properties for each document section.

outputType?Copy Anchor Link

keyof OutputByType = "blob"

The desired output format (default: "blob").

ReturnsCopy Anchor Link

Promise<string | readonly number[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | Blob | Buffer<ArrayBufferLike>>

A DOCX document in the specified format.

SeeCopy Anchor Link

• https://docx.js.org/#/usage/document
• https://docx.js.org/#/usage/sections
• https://docx.js.org/#/usage/packers