\n\nMD2DOCX is a robust library for converting Markdown Abstract Syntax Trees (MDAST) into DOCX documents. Built on the powerful `unified.js` and `docx.js` ecosystems, it offers a flexible, plugin-driven architecture that works seamlessly on both the client and server.\n\n[](https://github.com/md2docx/mdast2docx/actions/workflows/test.yml)\n[](https://codeclimate.com/github/md2docx/mdast2docx/maintainability)\n[](https://codecov.io/gh/md2docx/mdast2docx)\n[](https://www.npmjs.com/package/mdast2docx)\n[](https://www.npmjs.com/package/mdast2docx)\n\n\n---\n\n## ✨ Key Features\n\n- **Modular Architecture**: Keep your bundles small. The core is lightweight, and you can add features like tables, images, or math support via plugins.\n- **Comprehensive Markdown Support**: Handles all standard Markdown syntax, including headings, lists, links, code blocks, and more.\n- **Client & Server Ready**: Isomorphic design works flawlessly in both Node.js and browser environments.\n- **Highly Customizable**: Leverage the full power of `docx.js` to style your document, including headers, footers, margins, and paragraph styles.\n- **Scoped Packages**: Install only what you need using `@m2d/*` packages, or grab the all-in-one `mdast2docx` package.\n\n---\n\n## 🤖 The Generative AI Power-Up\n\nModern **Generative AI** tools often produce structured content in **Markdown**. This library acts as the perfect bridge to convert AI-generated artifacts into professionally formatted DOCX documents for editing, sharing, or record-keeping.\n\n**Workflow:** `AI Output (Markdown)` → `unified/remark (MDAST)` → `mdast2docx` → `Professional DOCX Document`\n\n- **AI-Generated Reports**: Convert AI-generated summaries and reports into polished DOCX files.\n- **Content Export**: Transform AI-generated blogs, articles, and research into an editable DOCX format.\n- **Flexible Processing**: Offload document generation to the client for scalability or run it on the server for high-performance batch processing.\n\n---\n\n## 📦 Installation\n\nYou can install the all-in-one package or select only the scoped packages you need.\n\n### **Install Everything at Once**\n\n```bash\npnpm add mdast2docx\n```\n\n### **Or Install Only What You Need**\n\n```bash\npnpm add @m2d/core @m2d/image @m2d/table # and other plugins\n```\n\n---\n\n## 🚀 Usage\n\nYou can use the library at a high level with `@m2d/remark-docx` for seamless integration with unified plugin system or at a lower level with `@m2d/core` + plugins ro `mdast2docx` for full control.\n\n### **Basic Example**\n\nThis example uses the core `toDocx` function to convert an MDAST object into a DOCX file and trigger a download in the browser.\n\n```typescript\nimport { toDocx } from \"mdast2docx\";\nimport { unified } from \"unified\";\nimport remarkParse from \"remark-parse\";\n\n// 1. Your Markdown content\nconst markdown = `\n# Sample Document\nThis is a paragraph with **bold** and _italic_ text.\n\n> A blockquote.\n\n* List Item 1\n* List Item 2\n\n[Visit our website](https://example.com)\n`;\n\n// 2. Parse Markdown to MDAST\nconst mdast = unified().use(remarkParse).parse(markdown);\n\n// 3. Convert MDAST to DOCX and download\nasync function generateDocx() {\n const docxBlob = await toDocx(mdast);\n\n // Create a download link\n const url = URL.createObjectURL(docxBlob as Blob);\n const link = document.createElement(\"a\");\n link.href = url;\n link.download = \"document.docx\";\n document.body.appendChild(link);\n link.click();\n document.body.removeChild(link);\n URL.revokeObjectURL(url);\n}\n\ngenerateDocx();\n```\n\n---\n\n## 🔌 Plugins\n\nThe core library is intentionally lean. Use plugins to add support for features like images, tables, math equations, and more.\n\n### **Example: Using Plugins**\n\nTo use plugins, install them and pass them into the configuration. You can apply plugins globally to all sections using defaultSectionProps or specify them for each section individually.\n\n```typescript\nimport { toDocx } from \"@m2d/core\";\nimport { imagePlugin } from \"@m2d/image\";\nimport { tablePlugin } from \"@m2d/table\";\nimport { mathPlugin } from \"@m2d/math\";\nimport { unified } from \"unified\";\nimport remarkParse from \"remark-parse\";\nimport remarkGfm from \"remark-gfm\"; // For table support\nimport remarkMath from \"remark-math\"; // For math support\n\nconst markdownWithFeatures = `\nAn image: \n\n| Header 1 | Header 2 |\n|----------|----------|\n| Cell 1 | Cell 2 |\n\nA math equation: $E = mc^2$\n`;\n\nconst mdast = unified()\n .use(remarkParse)\n .use(remarkGfm) // Enable GFM for tables\n .use(remarkMath) // Enable math syntax\n .parse(markdownWithFeatures);\n\n(async () => {\n const docxBlob = await toDocx(\n mdast,\n {}, // docxProps\n {\n // Pass plugins in sectionProps\n plugins: [imagePlugin(), tablePlugin(), mathPlugin()],\n }\n );\n // ... download logic ...\n})();\n```\n\n---\n\n## 📜 API Reference\n\n### **`toDocx(astInputs, docxProps?, sectionProps?, outputType?)`**\n\nConverts one or more MDAST trees into a DOCX document.\n\n| Parameter | Type | Description |\n| :------------- | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |\n| `astInputs` | `Root` | `{ ast: Root; props?: ISectionProps }[]` | A single MDAST root node or an array of nodes, each with optional section properties. |\n| `docxProps` | `IDocxProps` | Optional. Global document properties like title, author, and styles. See [docx.js docs](https://docx.js.org/#/usage/document). |\n| `sectionProps` | `ISectionProps` | Optional. Default properties for document sections, like margins and plugins. See [docx.js docs](https://docx.js.org/#/usage/sections). |\n| `outputType` | `\"blob\"` | `\"buffer\"` | `\"base64\"` | Optional. The output format. Defaults to `\"blob\"` in browsers and `\"buffer\"` in Node.js. |\n\n**Returns:** `Promise` — A promise that resolves with the generated DOCX document in the specified format.\n\n---\n\n## ✅ Supported Markdown Elements\n\n| Feature | Supported | Plugin Required |\n| :--------------------- | :-------: | :-------------- |\n| Headings (`# H1`) | ✅ | **No** |\n| Paragraphs | ✅ | **No** |\n| Bold & Italic | ✅ | **No** |\n| Blockquotes | ✅ | **No** |\n| Links | ✅ | **No** |\n| Code Blocks | ✅ | **No** |\n| Footnotes | ✅ | **No** |\n| Unordered Lists | ✅ | **No** |\n| Images `` | ✅ | `@m2d/image` |\n| Tables (GFM) | ✅ | `@m2d/table` |\n| Ordered Lists | ✅ | `@m2d/list` |\n| Math Equations (LaTeX) | ✅ | `@m2d/math` |\n| Raw HTML | ✅ | `@m2d/html` |\n\n---\n\n## 🤝 Contributing\n\nWe welcome contributions\\! Please feel free to fork the repository, create a feature branch, and open a pull request.\n\n1. **Fork** the repository.\n2. **Create a feature branch** (`git checkout -b feature/your-new-feature`).\n3. **Commit your changes** (`git commit -m \"Add a new feature\"`).\n4. **Push to the branch** (`git push origin feature/your-new-feature`).\n5. **Open a Pull Request**. 🚀\n\n---\n\n## 📄 License\n\nThis project is licensed under the **MPL-2.0**. See the [LICENSE](./LICENSE) file for details.\n\n---\n\n## 🙌 Acknowledgments\n\nA huge thank you to the creators and maintainers of the **docx.js** and **unified.js** ecosystems, which make this library possible.\n\n> ⭐ **Star this repository** if you find it useful! \n> ❤️ Support our work by [sponsoring on GitHub](https://github.com/sponsors/mayank1513).\n\n---\n\n
![\"logo\"](\"./banner.svg\")
\n![](\"https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png\")
\n\n**🚀 A powerful, modular, and extensible Markdown to DOCX converter.**\n\n