llms.txt
Compare with other sites' llms.txt files →# Md2Docx
> Universal Markdown to DOCX converter for Node.js and modern browsers. Converts CommonMark, GFM tables, math (LaTeX/OMML), Mermaid diagrams, and images into clean, native Microsoft Word documents.
## Project Information
- Website: https://md2docx.js.org
- Repository: https://github.com/md2docx/md2docx
- Documentation Dump: https://md2docx.js.org/llms-full.txt
- Execution Targets: Node.js (SSR / streaming / CLI) and modern browsers (zero server data transmission, Web Workers)
## Quick Start (CLI)
```bash
npx mdast2docx document.md -o document.docx
```
## Quick Start (API)
```typescript
import { mdast2docx } from "mdast2docx";
const docxBuffer = await mdast2docx("# Hello World\n\nFrom markdown to word.");
```
## Package Ecosystem
- `@m2d/md2docx`: All-in-one batteries-included Markdown to DOCX converter for browser & client applications.
- `mdast2docx`: Umbrella distribution bundle providing toDocx and all official plugins.
- `@m2d/core`: Headless AST compiler, plugin lifecycle, and document generator.
- `@m2d/cli`: Command-line interface for terminal & batch document generation.
- `@m2d/table`: GitHub Flavored Markdown (GFM) table formatting, borders, and column alignment.
- `@m2d/list`: Multi-level ordered/unordered lists with hierarchical indentation preservation.
- `@m2d/math`: LaTeX to native Word Office Math Markup Language (OMML).
- `@m2d/mermaid`: Browser Mermaid diagram renderer with self-healing syntax repair.
- `@m2d/mermaid-node`: Headless zero-DOM Node Mermaid rasterization via beautiful-mermaid and sharp.
- `@m2d/image`: Universal browser image loader and dimension calculator with IndexedDB caching.
- `@m2d/image-node`: Node-specific image fetcher and file loader powered by sharp.
- `@m2d/html`: Raw HTML sanitization and conversion into Word elements using browser DOM.
- `@m2d/html-node`: Server-side DOM-less HTML parser powered by linkedom.
- `@m2d/remark-docx`: Official Unified/Remark compiler plugin for direct DOCX output.
- `@m2d/remark-docx-node`: Server-side Remark compiler plugin with native image & Mermaid diagram support.
- `@m2d/react-markdown`: React components and hooks for client-side document export.
- `@m2d/cache`: High-performance in-memory and persistent caching layer.
- `@m2d/mdast`: Extended MDAST and HAST TypeScript type definitions.
## Documentation Index
- [createPersistentCache()](/docs/cache/api/functions/createPersistentCache):
- [generateCacheKey()](/docs/cache/api/functions/generateCacheKey):
- [readFromCache()](/docs/cache/api/functions/readFromCache):
- [simpleCleanup()](/docs/cache/api/functions/simpleCleanup):
- [stableSerialize()](/docs/cache/api/functions/stableSerialize):
- [writeToCache()](/docs/cache/api/functions/writeToCache):
- [API Docs](/docs/cache/api):
- [CacheConfigType<TResult\>](/docs/cache/api/type-aliases/CacheConfigType):
- [Overview](/docs/cache/overview):
- [defineConfig()](/docs/cli/v0/api/functions/defineConfig):
- [md2docx()](/docs/cli/v0/api/functions/md2docx):
- [shared()](/docs/cli/v0/api/functions/shared):
- [API Docs](/docs/cli/v0/api):
- [IPlugin<T\>](/docs/cli/v0/api/interfaces/IPlugin):
- [Mdast2DocxNodePluginProps](/docs/cli/v0/api/interfaces/Mdast2DocxNodePluginProps):
- [SharedOptions](/docs/cli/v0/api/interfaces/SharedOptions):
- [IDocxProps](/docs/cli/v0/api/type-aliases/IDocxProps):
- [ISectionProps](/docs/cli/v0/api/type-aliases/ISectionProps):
- [OutputByType](/docs/cli/v0/api/type-aliases/OutputByType):
- [OutputType](/docs/cli/v0/api/type-aliases/OutputType):
- [DEFAULT_CONFIG](/docs/cli/v0/api/variables/DEFAULT_CONFIG):
- [Command-Line Interface (`@m2d/cli`)](/docs/cli/v0/cli-usage): Command-line interface guide, executable binaries, and CI/CD automation.
- [Configuration & Custom Plugins](/docs/cli/v0/configuration-and-plugins): How to configure @m2d/cli and inject custom AST plugins using md2docx.config.ts.
- [Overview](/docs/cli/v0/overview):
- [Programmatic Node.js API](/docs/cli/v0/programmatic-api): Using md2docx programmatically in Node.js scripts, backend servers, and serverless functions.
- [defineConfig()](/docs/cli/api/functions/defineConfig):
- [md2docx()](/docs/cli/api/functions/md2docx):
- [toDocxFile()](/docs/cli/api/functions/toDocxFile):
- [API Docs](/docs/cli/api):
- [IPlugin<T\>](/docs/cli/api/interfaces/IPlugin):
- [Mdast2DocxNodePluginProps](/docs/cli/api/interfaces/Mdast2DocxNodePluginProps):
- [ToDocxFileOptions](/docs/cli/api/interfaces/ToDocxFileOptions):
- [IDocxProps](/docs/cli/api/type-aliases/IDocxProps):
- [ISectionProps](/docs/cli/api/type-aliases/ISectionProps):
- [OutputByType](/docs/cli/api/type-aliases/OutputByType):
- [OutputType](/docs/cli/api/type-aliases/OutputType):
- [DEFAULT_CONFIG](/docs/cli/api/variables/DEFAULT_CONFIG):
- [Command-Line Interface (`@m2d/cli`)](/docs/cli/cli-usage): Command-line interface guide, executable binaries, and CI/CD automation.
- [Configuration & Custom Plugins](/docs/cli/configuration-and-plugins): How to configure @m2d/cli and inject custom AST plugins using md2docx.config.ts.
- [Overview](/docs/cli/overview):
- [Programmatic Node.js API](/docs/cli/programmatic-api): Using md2docx programmatically in Node.js scripts, backend servers, and serverless functions.
- [toDocx()](/docs/core/api/functions/toDocx):
- [API Docs](/docs/core/api):
- [Alternative](/docs/core/api/interfaces/Alternative):
- [Association](/docs/core/api/interfaces/Association):
- [BlockContentMap](/docs/core/api/interfaces/BlockContentMap):
- [Blockquote](/docs/core/api/interfaces/Blockquote):
- [BlockquoteData](/docs/core/api/interfaces/BlockquoteData):
- [Break](/docs/core/api/interfaces/Break):
- [BreakData](/docs/core/api/interfaces/BreakData):
- [Checkbox](/docs/core/api/interfaces/Checkbox):
- [CheckboxData](/docs/core/api/interfaces/CheckboxData):
- [Code](/docs/core/api/interfaces/Code):
- [CodeData](/docs/core/api/interfaces/CodeData):
- [Data](/docs/core/api/interfaces/Data):
- [Definition](/docs/core/api/interfaces/Definition):
- [DefinitionContentMap](/docs/core/api/interfaces/DefinitionContentMap):
- [DefinitionData](/docs/core/api/interfaces/DefinitionData):
- [Delete](/docs/core/api/interfaces/Delete):
- [DeleteData](/docs/core/api/interfaces/DeleteData):
- [Emphasis](/docs/core/api/interfaces/Emphasis):
- [EmphasisData](/docs/core/api/interfaces/EmphasisData):
- [EmptyNode](/docs/core/api/interfaces/EmptyNode):
- [FootnoteDefinition](/docs/core/api/interfaces/FootnoteDefinition):
- [FootnoteDefinitionData](/docs/core/api/interfaces/FootnoteDefinitionData):
- [FootnoteReference](/docs/core/api/interfaces/FootnoteReference):
- [FootnoteReferenceData](/docs/core/api/interfaces/FootnoteReferenceData):
- [Fragment](/docs/core/api/interfaces/Fragment):
- [FragmentData](/docs/core/api/interfaces/FragmentData):
- [FrontmatterContentMap](/docs/core/api/interfaces/FrontmatterContentMap):
- [Heading](/docs/core/api/interfaces/Heading):
- [HeadingData](/docs/core/api/interfaces/HeadingData):
- [Html](/docs/core/api/interfaces/Html):
- [HtmlData](/docs/core/api/interfaces/HtmlData):
- [IPlugin<T\>](/docs/core/api/interfaces/IPlugin):
- [Image](/docs/core/api/interfaces/Image):
- [ImageData](/docs/core/api/interfaces/ImageData):
- [ImageReference](/docs/core/api/interfaces/ImageReference):
- [ImageReferenceData](/docs/core/api/interfaces/ImageReferenceData):
- [InlineCode](/docs/core/api/interfaces/InlineCode):
- [InlineCodeData](/docs/core/api/interfaces/InlineCodeData):
- [Link](/docs/core/api/interfaces/Link):
- [LinkData](/docs/core/api/interfaces/LinkData):
- [LinkReference](/docs/core/api/interfaces/LinkReference):
- [LinkReferenceData](/docs/core/api/interfaces/LinkReferenceData):
- [List](/docs/core/api/interfaces/List):
- [ListContentMap](/docs/core/api/interfaces/ListContentMap):
- [ListData](/docs/core/api/interfaces/ListData):
- [ListItem](/docs/core/api/interfaces/ListItem):
- [ListItemData](/docs/core/api/interfaces/ListItemData):
- [Literal](/docs/core/api/interfaces/Literal):
- [Node](/docs/core/api/interfaces/Node):
- [Paragraph](/docs/core/api/interfaces/Paragraph):
- [ParagraphData](/docs/core/api/interfaces/ParagraphData):
- [Parent](/docs/core/api/interfaces/Parent):
- [PhrasingContentMap](/docs/core/api/interfaces/PhrasingContentMap):
- [Reference](/docs/core/api/interfaces/Reference):
- [Resource](/docs/core/api/interfaces/Resource):
- [Root](/docs/core/api/interfaces/Root):
- [RootContentMap](/docs/core/api/interfaces/RootContentMap):
- [RootData](/docs/core/api/interfaces/RootData):
- [RowContentMap](/docs/core/api/interfaces/RowContentMap):
- [SVG](/docs/core/api/interfaces/SVG):
- [SVGData](/docs/core/api/interfaces/SVGData):
- [Strong](/docs/core/api/interfaces/Strong):
- [StrongData](/docs/core/api/interfaces/StrongData):
- [Table](/docs/core/api/interfaces/Table):
- [TableCell](/docs/core/api/interfaces/TableCell):
- [TableCellData](/docs/core/api/interfaces/TableCellData):
- [TableContentMap](/docs/core/api/interfaces/TableContentMap):
- [TableData](/docs/core/api/interfaces/TableData):
- [TableRow](/docs/core/api/interfaces/TableRow):
- [TableRowData](/docs/core/api/interfaces/TableRowData):
- [Text](/docs/core/api/interfaces/Text):
- [TextData](/docs/core/api/interfaces/TextData):
- [ThematicBreak](/docs/core/api/interfaces/ThematicBreak):
- [ThematicBreakData](/docs/core/api/interfaces/ThematicBreakData):
- [Yaml](/docs/core/api/interfaces/Yaml):
- [YamlData](/docs/core/api/interfaces/YamlData):
- [AlignType](/docs/core/api/type-aliases/AlignType):
- [BlockContent](/docs/core/api/type-aliases/BlockContent):
- [~~Type Alias: Content~~](/docs/core/api/type-aliases/Content):
- [DefinitionContent](/docs/core/api/type-aliases/DefinitionContent):
- [FrontmatterContent](/docs/core/api/type-aliases/FrontmatterContent):
- [~~Type Alias: HTML~~](/docs/core/api/type-aliases/HTML):
- [IDocxProps](/docs/core/api/type-aliases/IDocxProps):
- [IInputMDAST](/docs/core/api/type-aliases/IInputMDAST):
- [ISectionProps](/docs/core/api/type-aliases/ISectionProps):
- [Immutable<T\>](/docs/core/api/type-aliases/Immutable):
- [ListContent](/docs/core/api/type-aliases/ListContent):
- [Literals](/docs/core/api/type-aliases/Literals):
- [Mutable<T\>](/docs/core/api/type-aliases/Mutable):
- [Nodes](/docs/core/api/type-aliases/Nodes):
- [Optional<T\>](/docs/core/api/type-aliases/Optional):
- [Parents](/docs/core/api/type-aliases/Parents):
- [PhrasingContent](/docs/core/api/type-aliases/PhrasingContent):
- [ReferenceType](/docs/core/api/type-aliases/ReferenceType):
- [Required<T\>](/docs/core/api/type-aliases/Required):
- [RootContent](/docs/core/api/type-aliases/RootContent):
- [RowContent](/docs/core/api/type-aliases/RowContent):
- [TableContent](/docs/core/api/type-aliases/TableContent):
- [TopLevelContent](/docs/core/api/type-aliases/TopLevelContent):
- [~~Type Alias: YAML~~](/docs/core/api/type-aliases/YAML):
- [Caching Architecture (`@m2d/core/cache`)](/docs/core/caching): Multi-tiered caching engine with timestamped TTL and lock-free concurrency.
- [Overview](/docs/core/overview):
- [Authoring Custom Plugins for `@m2d/core`](/docs/core/plugin-authoring): Guide to authoring custom plugins for @m2d/core lifecycle hooks.
- [Sections, Layouts & Heading Hierarchy](/docs/core/sections-and-layout): Guide to multi-section documents, page orientation, headers, and footers.
- [extractFrontmatterNode()](/docs/frontmatter/api/functions/extractFrontmatterNode):
- [frontmatterPlugin()](/docs/frontmatter/api/functions/frontmatterPlugin):
- [API Docs](/docs/frontmatter/api):
- [CoverPageOptions](/docs/frontmatter/api/interfaces/CoverPageOptions):
- [FrontmatterData](/docs/frontmatter/api/interfaces/FrontmatterData):
- [FrontmatterPluginOptions](/docs/frontmatter/api/interfaces/FrontmatterPluginOptions):
- [InfoBoxOptions](/docs/frontmatter/api/interfaces/InfoBoxOptions):
- [FrontmatterParser](/docs/frontmatter/api/type-aliases/FrontmatterParser):
- [FrontmatterType](/docs/frontmatter/api/type-aliases/FrontmatterType):
- [parseFrontmatter](/docs/frontmatter/api/variables/parseFrontmatter):
- [Configuration & Parsers](/docs/frontmatter/configuration): Configure YAML/TOML frontmatter parsing, metadata field mappings, and custom third-party parser engines.
- [Overview](/docs/frontmatter/overview):
- [API Docs](/docs/html-node/api):
- [NodeHtmlPluginOptions](/docs/html-node/api/interfaces/NodeHtmlPluginOptions):
- [htmlNodePlugin](/docs/html-node/api/variables/htmlNodePlugin):
- [htmlPlugin](/docs/html-node/api/variables/htmlPlugin):
- [nodeHtmlPlugin](/docs/html-node/api/variables/nodeHtmlPlugin):
- [Overview](/docs/html-node/overview):
- [createHtmlPlugin()](/docs/html/api/functions/createHtmlPlugin):
- [parseCssRules()](/docs/html/api/functions/parseCssRules):
- [API Docs](/docs/html/api):
- [HtmlPluginOptions](/docs/html/api/interfaces/HtmlPluginOptions):
- [ParsedCssRule](/docs/html/api/interfaces/ParsedCssRule):
- [htmlPlugin](/docs/html/api/variables/htmlPlugin):
- [AST Transformation & Pipeline Ordering](/docs/html/ast-transformation-and-pipeline-order): How raw HTML strings are transformed into extended MDAST nodes and why early plugin execution is critical.
- [Overview](/docs/html/overview):
- [Supported Elements & Inline CSS](/docs/html/supported-elements-and-inline-css): Comprehensive list of supported HTML tags, typography mappings, and CSS properties.
- [API Docs](/docs/image-node/api):
- [INodeImagePluginOptions](/docs/image-node/api/interfaces/INodeImagePluginOptions):
- [NodeImageErrorData](/docs/image-node/api/interfaces/NodeImageErrorData):
- [ImageErrorMode](/docs/image-node/api/type-aliases/ImageErrorMode):
- [MermaidFallbackMode](/docs/image-node/api/type-aliases/MermaidFallbackMode):
- [NodeImageResolver](/docs/image-node/api/type-aliases/NodeImageResolver):
- [SupportedImageType](/docs/image-node/api/type-aliases/SupportedImageType):
- [SvgFallbackMode](/docs/image-node/api/type-aliases/SvgFallbackMode):
- [SUPPORTED_IMAGE\_TYPES](/docs/image-node/api/variables/SUPPORTED_IMAGE_TYPES):
- [defaultNodeImageResolver](/docs/image-node/api/variables/defaultNodeImageResolver):
- [imageNodePlugin](/docs/image-node/api/variables/imageNodePlugin):
- [nodeImagePlugin](/docs/image-node/api/variables/nodeImagePlugin):
- [Fallbacks & Error Policies](/docs/image-node/fallbacks-and-error-modes): Error policies, diagram code block fallbacks, and collapsible headings in Word.
- [Overview](/docs/image-node/overview):
- [Server-Side Image Resolution (`@m2d/image-node`)](/docs/image-node/server-resolution): Headless image and SVG resolution using sharp in Node.js environments.
- [API Docs](/docs/image/api):
- [IDefaultImagePluginOptions](/docs/image/api/interfaces/IDefaultImagePluginOptions):
- [ImageErrorData](/docs/image/api/interfaces/ImageErrorData):
- [IImagePluginOptions](/docs/image/api/type-aliases/IImagePluginOptions):
- [ImageErrorMode](/docs/image/api/type-aliases/ImageErrorMode):
- [ImageResolver](/docs/image/api/type-aliases/ImageResolver):
- [MermaidFallbackMode](/docs/image/api/type-aliases/MermaidFallbackMode):
- [SvgFallbackMode](/docs/image/api/type-aliases/SvgFallbackMode):
- [imagePlugin](/docs/image/api/variables/imagePlugin):
- [Custom Resolvers & Caching](/docs/image/custom-resolvers-and-caching): Implementing custom image loaders, authentication headers, and multi-tier caching.
- [Error Handling & Diagram Fallbacks](/docs/image/error-handling-and-fallbacks): Strategies for handling broken images, remote fetch errors, and failed diagrams.
- [Overview](/docs/image/overview):
- [createLevels()](/docs/list/api/functions/createLevels):
- [API Docs](/docs/list/api):
- [IListPluginOptions](/docs/list/api/type-aliases/IListPluginOptions):
- [listPlugin](/docs/list/api/variables/listPlugin):
- [Bullet Styles & Nesting](/docs/list/bullet-styles-and-nesting): Customizing bullet glyph hierarchies, indentation, and Word default bullet modes.
- [Ordered Lists & Hierarchical Numbering](/docs/list/ordered-lists-and-numbering): Configuring multi-level numbering schemas, hierarchical decimals, and indentation.
- [Overview](/docs/list/overview):
- [parseLatex()](/docs/math/api/functions/parseLatex):
- [API Docs](/docs/math/api):
- [IMathPluginOptions](/docs/math/api/interfaces/IMathPluginOptions):
- [MathErrorMode](/docs/math/api/type-aliases/MathErrorMode):
- [mathPlugin](/docs/math/api/variables/mathPlugin):
- [LaTeX Syntax & Symbols](/docs/math/latex-syntax-and-symbols): Supported LaTeX mathematical expressions, macros, and native Word MathML conversion.
- [Overview](/docs/math/overview):
- [Resiliency & Error Modes](/docs/math/resiliency-and-error-modes): Strategies for handling malformed LaTeX syntax, unclosed delimiters, and runaway markdown parsing.
- [md2docx()](/docs/api/functions/md2docx):
- [API Docs](/docs/api):
- [Mdast2DocxPluginProps](/docs/api/interfaces/Mdast2DocxPluginProps):
- [IDocxProps](/docs/api/type-aliases/IDocxProps):
- [ISectionProps](/docs/api/type-aliases/ISectionProps):
- [OutputType](/docs/api/type-aliases/OutputType):
- [Core Concepts](/docs/core-concepts): Understand the compilation pipeline, MDAST tree transformation, and OpenXML packaging architecture.
- [Frontmatter & Document Metadata](/docs/frontmatter-and-metadata): Extract YAML and TOML frontmatter headers from Markdown to populate native Microsoft Word document properties.
- [Overview](/docs/overview):
- [Plugin Authoring Guide](/docs/plugin-authoring): Learn how to build custom AST transformations, block renderers, inline element handlers, and document metadata extensions for md2docx.
- [Quick Start](/docs/quick-start): Get up and running with md2docx in under 2 minutes across Browser, Node.js, and Full-Stack frameworks.
- [API Docs](/docs/mdast/api):
- [Alternative](/docs/mdast/api/interfaces/Alternative):
- [Association](/docs/mdast/api/interfaces/Association):
- [BlockContentMap](/docs/mdast/api/interfaces/BlockContentMap):
- [Blockquote](/docs/mdast/api/interfaces/Blockquote):
- [BlockquoteData](/docs/mdast/api/interfaces/BlockquoteData):
- [Break](/docs/mdast/api/interfaces/Break):
- [BreakData](/docs/mdast/api/interfaces/BreakData):
- [Checkbox](/docs/mdast/api/interfaces/Checkbox):
- [CheckboxData](/docs/mdast/api/interfaces/CheckboxData):
- [Code](/docs/mdast/api/interfaces/Code):
- [CodeData](/docs/mdast/api/interfaces/CodeData):
- [Data](/docs/mdast/api/interfaces/Data):
- [Definition](/docs/mdast/api/interfaces/Definition):
- [DefinitionContentMap](/docs/mdast/api/interfaces/DefinitionContentMap):
- [DefinitionData](/docs/mdast/api/interfaces/DefinitionData):
- [Delete](/docs/mdast/api/interfaces/Delete):
- [DeleteData](/docs/mdast/api/interfaces/DeleteData):
- [Emphasis](/docs/mdast/api/interfaces/Emphasis):
- [EmphasisData](/docs/mdast/api/interfaces/EmphasisData):
- [EmptyNode](/docs/mdast/api/interfaces/EmptyNode):
- [FootnoteDefinition](/docs/mdast/api/interfaces/FootnoteDefinition):
- [FootnoteDefinitionData](/docs/mdast/api/interfaces/FootnoteDefinitionData):
- [FootnoteReference](/docs/mdast/api/interfaces/FootnoteReference):
- [FootnoteReferenceData](/docs/mdast/api/interfaces/FootnoteReferenceData):
- [Fragment](/docs/mdast/api/interfaces/Fragment):
- [FragmentData](/docs/mdast/api/interfaces/FragmentData):
- [FrontmatterContentMap](/docs/mdast/api/interfaces/FrontmatterContentMap):
- [Heading](/docs/mdast/api/interfaces/Heading):
- [HeadingData](/docs/mdast/api/interfaces/HeadingData):
- [Html](/docs/mdast/api/interfaces/Html):
- [HtmlData](/docs/mdast/api/interfaces/HtmlData):
- [Image](/docs/mdast/api/interfaces/Image):
- [ImageData](/docs/mdast/api/interfaces/ImageData):
- [ImageReference](/docs/mdast/api/interfaces/ImageReference):
- [ImageReferenceData](/docs/mdast/api/interfaces/ImageReferenceData):
- [InlineCode](/docs/md