![](\"https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png\")
\n\n[](https://github.com/md2docx/remark-docx/actions/workflows/test.yml) [](https://codecov.io/gh/md2docx/remark-docx) [](https://www.npmjs.com/package/@m2d/remark-docx)\n\n\n\n> A Unified/Remark plugin that injects a DOCX compiler using [`mdast2docx`](https://github.com/md2docx/mdast2docx) and outputs `.docx` files from Markdown.\n\n---\n\n## π§ Overview\n\n`@m2d/remark-docx` enables direct export of Markdown content to Microsoft Word (`.docx`) using the Unified ecosystem. It seamlessly bridges `remark` with the [`mdast2docx`](https://github.com/md2docx/mdast2docx) compiler and auto-injects common plugins like GFM tables, math, lists, and inline HTML support.\n\nItβs designed for both **browser** and **Node.js** environments, handling environment-specific features like image or HTML parsing smartly.\n\n---\n\n## β¨ Features\n\n- π Converts Markdown to `.docx` using `mdast2docx`\n- π Auto-injects plugins for GFM tables, math, lists, images, and HTML\n- π§ Smart: excludes DOM-only plugins in Node.js\n- π₯ Supports both `.process()` and `.processSync()` with an async `.result`\n- π Output as `Blob`, `Buffer`, or `base64`\n\n---\n\n## π¦ Installation\n\n```bash\nnpm install @m2d/remark-docx docx\n```\n\nAlso install any optional plugins you wish to include in your pipeline:\n\n```bash\nnpm install remark-parse remark-gfm remark-math remark-frontmatter\n```\n\nOther package managers:\n\n```bash\nyarn add @m2d/remark-docx docx\npnpm add @m2d/remark-docx docx\n```\n\n---\n\n## π Usage\n\n### π Browser Example (Async)\n\n```ts\nimport { unified } from \"unified\";\nimport remarkParse from \"remark-parse\";\nimport remarkGfm from \"remark-gfm\";\nimport remarkMath from \"remark-math\";\nimport remarkFrontmatter from \"remark-frontmatter\";\nimport { remarkDocx } from \"@m2d/remark-docx\";\n\nconst processor = unified()\n .use(remarkParse)\n .use(remarkGfm)\n .use(remarkFrontmatter)\n .use(remarkMath)\n .use(remarkDocx);\n\nconst downloadDocx = () => {\n processor\n .process(md)\n .then(res => res.result)\n .then(blob => {\n const url = URL.createObjectURL(blob as Blob);\n const link = document.createElement(\"a\");\n link.href = url;\n link.download = \"document.docx\";\n link.click();\n URL.revokeObjectURL(url);\n });\n};\n```\n\n### β‘ Browser Example (Sync + Async Result)\n\n```ts\nconst { result } = processor.processSync(md) as { result: PromiseMade with π by Mayank Kumar Chaudhari
\n","readmeFilename":"README.md"}