# @mdast2docx/core

> Core engine to convert extended MDAST to DOCX. Supports plugins for footnotes, images, lists, tables, and more. Designed for seamless Markdown-to-DOCX conversion.

Latest version **1.8.1** (published 2026-10-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @mdast2docx/core
pnpm add @mdast2docx/core
yarn add @mdast2docx/core
bun add @mdast2docx/core
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.8.1 |
| Published | 2026-10-22 |
| First published | 2025-04-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 12.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 6 |
| Author | Mayank Kumar Chaudhari |
| Maintainers | mayank1513 |
| Keywords | @m2d/core, mdast, markdown, generative-ai, docx-for-generative-ai, docx, markdown-to-docx, mdast-to-docx, remark, unified, text-processing, document-generator, typescript, open-source, export, document-generation, customizable, renderer, plugin-system, footnotes, tables, lists, images, headings, rich-text, automation, seamless-integration, cutting-edge, frontend, modern, compatibility, mayank1513, turboforge |

## Links

- npm: https://www.npmjs.com/package/@mdast2docx/core
- Repository: https://github.com/md2docx/md2docx
- Homepage: https://github.com/md2docx/md2docx/blob/main/packages/core/README.md
- Issues: https://github.com/md2docx/md2docx/issues
- Funding: https://github.com/sponsors/md2docx
- npm.io page: https://npm.io/package/@mdast2docx/core

## Dependencies (1)

- [@m2d/core](https://npm.io/package/@m2d/core.md) 1.8.1

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.8.1 (latest) — 2026-10-22
- 1.7.1 — 2025-10-29
- 1.7.0 — 2025-09-20
- 1.6.0 — 2025-09-19
- 1.5.0 — 2025-06-24
- 1.4.3 — 2025-06-24
- 1.4.2 — 2025-06-16
- 1.4.1 — 2025-06-12
- 1.4.0 — 2025-06-12
- 1.3.4 — 2025-06-06
- 1.3.3 — 2025-06-06
- 1.3.2 — 2025-06-06
- 1.3.1 — 2025-06-06
- 1.3.0 — 2025-06-06
- 1.2.0 — 2025-06-01
- … 11 more at https://npm.io/package/@mdast2docx/core/versions

## README

# @m2d/core <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 40px"/>

<p className="flex gap-2">
  <a href="https://github.com/md2docx/md2docx/actions/workflows/ci.yml" rel="noopener noreferrer">
    <img alt="CI" src="https://github.com/md2docx/md2docx/actions/workflows/ci.yml/badge.svg" />
  </a>
  <a href="https://codecov.io/gh/md2docx/md2docx/tree/main/packages/@m2d/core" rel="noopener noreferrer">
    <img alt="codecov" src="https://codecov.io/gh/md2docx/md2docx/graph/badge.svg?flag=@m2d/core" />
  </a> 
  <a href="https://npmjs.com/package/@m2d/core" rel="noopener noreferrer">
    <img alt="npm version" src="https://img.shields.io/npm/v/@m2d/core" />
  </a>
  <a href="https://npmjs.com/package/@m2d/core" rel="noopener noreferrer">
    <img alt="npm downloads" src="https://img.shields.io/npm/d18m/@m2d/core" />
  </a>
  <a href="https://npmjs.com/package/@m2d/core" rel="noopener noreferrer">
    <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/@m2d/core" />
  </a>
  <img alt="license" src="https://img.shields.io/npm/l/@m2d/core" />
</p>

> @m2d/core: Core engine to convert extended MDAST to DOCX. Supports plugins for footnotes, images, lists, tables, and more. Designed for seamless Markdown-to-DOCX conversion.

---

## ✨ Features

- ⚡ **Lightweight & Fast**: Direct conversion from Markdown Abstract Syntax Trees (MDAST) into native OpenXML Word structures.
- 🌐 **Dual-Runtime Compatibility**: Runs 100% in-browser (`Blob`, zero server required) and on server runtimes (`Buffer`, `Uint8Array` in Node.js, Next.js, Cloudflare Workers).
- 📑 **Section & Layout Control**: Multi-section documents with individual page sizes, orientation (Portrait/Landscape), margins, headers, and footers.
- 🔌 **Extensible Plugin Pipeline**: Rich lifecycle hooks (`preprocess`, `inline`, `block`, `postprocess`) for images, diagrams, math equations, and HTML.
- 🛡️ **Defensive & Resilient**: Built-in warning deduplication (`warnOnce`), safe error fallbacks, and non-mutating option handling.
- 💾 **Persistent Caching Engine**: Multi-tiered cache (`@m2d/core/cache`) using IndexedDB and in-memory caches with timestamped TTL and lock-free concurrency.

---

## 📦 Installation


> [!TIP]
> **This package (@mdast2docx/core) is an official alias of [@m2d/core](https://npmjs.com/package/@m2d/core).**

<details>
<summary>Why does this exist?</summary>

We provide this package to offer shorter import paths and improved discoverability. While both packages provide identical functionality, **@m2d/core** is the primary source of truth.
</details>

<details>
<summary>Which one should I use?</summary>

* **Use @mdast2docx/core** if you prefer the shorter name or specific branding or ESM Only.
* **Use @m2d/core** for the most stable long-term reference and standard alignment.

| Feature | @m2d/core | @mdast2docx/core |
| --- | --- | --- |
| **Source Code** | ✅ Primary | 🔗 Proxy |
| **Updates** | Immediate | Synchronized (Immediately) |
| **Bundle Size** | 100% | 100% (Zero overhead) |
| **Format** | ESM + CJS | ESM Only |
| **Maintenance** | ✅ Primary | 🔗 Proxy (inherits) |
| **Security** | ✅ Primary | 🔗 Proxy (inherits) |

</details>

<details>
<summary>Maintenance & Support</summary>

> **Security:** Security audits are performed on the canonical package; this alias inherits all security patches automatically.
</details>

---



```bash
$ pnpm add @m2d/core docx
```

**_or_**

```bash
$ npm install @m2d/core docx
```

**_or_**

```bash
$ yarn add @m2d/core docx
```

---

## 🚀 Quick Start

Convert a Markdown string to a Word `.docx` file in just a few lines:

```typescript
import { toDocx } from "@m2d/core";
import remarkParse from "remark-parse";
import remarkGfm from "remark-gfm";
import { unified } from "unified";

// 1. Parse Markdown into an MDAST tree
const markdown = "# Project Overview\n\nGenerated with **@m2d/core**.";
const mdast = unified().use(remarkParse).use(remarkGfm).parse(markdown);

// 2. Convert MDAST to a DOCX Blob (or 'buffer' on server)
const docxBlob = await toDocx(mdast, {
  title: "Project Overview",
  creator: "md2docx",
});

// 3. In the browser, trigger download or save
const url = URL.createObjectURL(docxBlob as Blob);
const a = document.createElement("a");
a.href = url;
a.download = "document.docx";
a.click();
```

---

## 🔌 Official Plugins Ecosystem

`@m2d/core` stays lean by delegating domain-specific nodes to modular plugins. Install only what you need:

| Plugin | Package | Environment | Purpose |
| :--- | :--- | :--- | :--- |
| **HTML** | [`@m2d/html`](https://www.npmjs.com/package/@m2d/html) | Browser / Node | Parses inline HTML styling, `<kbd>`, `<mark>`, badges, and embeds |
| **Image** | [`@m2d/image`](https://www.npmjs.com/package/@m2d/image) | Browser | In-browser canvas rasterization for SVGs, URLs, and Base64 images |
| **Image (Node)** | [`@m2d/image-node`](https://www.npmjs.com/package/@m2d/image-node) | Server (Node.js) | Server-side image and SVG rasterization via `sharp` |
| **Mermaid** | [`@m2d/mermaid`](https://www.npmjs.com/package/@m2d/mermaid) | Browser | Renders client-side Mermaid diagrams into SVG/PNG with auto-fixer |
| **Mermaid (Node)** | [`@m2d/mermaid-node`](https://www.npmjs.com/package/@m2d/mermaid-node) | Server (Node.js) | Server-side DOM-less Mermaid diagrams via `beautiful-mermaid` |
| **Math** | [`@m2d/math`](https://www.npmjs.com/package/@m2d/math) | Browser / Node | Compiles LaTeX math formulas into native Word `<m:oMath>` equations |
| **Table** | [`@m2d/table`](https://www.npmjs.com/package/@m2d/table) | Browser / Node | Renders GFM tables with column alignments, borders, and header fills |
| **List** | [`@m2d/list`](https://www.npmjs.com/package/@m2d/list) | Browser / Node | Formats ordered, unordered, and nested hierarchical lists |
| **MDAST Types** | [`@m2d/mdast`](https://www.npmjs.com/package/@m2d/mdast) | Browser / Node | TypeScript types for extended MDAST AST nodes |

### Using Plugins

```typescript
import { toDocx } from "@m2d/core";
import { tablePlugin } from "@m2d/table";
import { imagePlugin } from "@m2d/image";

const docxBlob = await toDocx(mdast, {}, {
  plugins: [tablePlugin(), imagePlugin()],
});
```

---

## 📜 API Reference

### `toDocx(astInputs, docxProps?, defaultSectionProps?, outputType?)`

```typescript
function toDocx(
  astInputs: Root | { ast: Root; props?: ISectionProps }[],
  docxProps?: IDocxProps,
  defaultSectionProps?: IDefaultSectionOptions,
  outputType?: "blob" | "buffer" | "arraybuffer",
): Promise<Blob | Buffer | ArrayBuffer | Uint8Array>;
```

#### Parameters

- **`astInputs`**: An MDAST `Root` node, or an array of section descriptors `{ ast: Root, props?: ISectionProps }[]` for multi-section documents.
- **`docxProps`** *(optional)*: Global document properties passed to `docx.Document` (title, author, subject, styles, etc.).
- **`defaultSectionProps`** *(optional)*: Layout and conversion configuration applied to sections:
  - `useTitle` *(boolean, default: `true`)*: Maps top-level `# Heading` to Word's `Title` style and demotes nested headings proportionally.
  - `plugins` *(IPlugin[])*: Array of conversion plugins.
  - `trimInnerSpaces` *(boolean, default: `true`)*: Normalizes repeated whitespace in text runs.
  - Plus standard `docx` `ISectionOptions` (margins, paper size, orientation, headers, footers).
- **`outputType`** *(optional, default: `'blob'`)*: Target binary format (`"blob"`, `"buffer"`, or `"arraybuffer"`).

---

## 📚 Deep Dive Guides & Architecture

Explore our dedicated documentation guides for advanced configurations and internal know-how:

- ⚡ **[Caching Architecture Guide](./docs/caching.mdx)**: Multi-tiered cache design, why TTL avoids write-amplification, lock-free IndexedDB concurrency, and `shouldCache` validation.
- 🔌 **[Plugin Authoring Guide](./docs/plugin-authoring.mdx)**: How to create custom plugins, hook into `preprocess`, `block`, `inline`, and `postprocess` lifecycles, and handle errors.
- 📑 **[Sections & Layout Guide](./docs/sections-and-layout.mdx)**: Crafting multi-section documents, landscape pages, custom margins, and heading hierarchy.

---

## License

This library is licensed under the MIT open-source license.

<hr />

<p align="center">with 💖 by <a href="https://mayankchaudhari.com" target="_blank">Mayank Kumar Chaudhari</a></p>

---
_Source: https://npm.io/package/@mdast2docx/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._