`.
---
## 📦 Installation
> [!TIP]
> **This package (@mdast2docx/mdast) is an official alias of [@m2d/mdast](https://npmjs.com/package/@m2d/mdast).**
Why does this exist?
We provide this package to offer shorter import paths and improved discoverability. While both packages provide identical functionality, **@m2d/mdast** is the primary source of truth.
Which one should I use?
* **Use @mdast2docx/mdast** if you prefer the shorter name or specific branding or ESM Only.
* **Use @m2d/mdast** for the most stable long-term reference and standard alignment.
| Feature | @m2d/mdast | @mdast2docx/mdast |
| --- | --- | --- |
| **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) |
Maintenance & Support
> **Security:** Security audits are performed on the canonical package; this alias inherits all security patches automatically.
---
```bash
$ pnpm add @m2d/mdast
```
**_or_**
```bash
$ npm install @m2d/mdast
```
**_or_**
```bash
$ yarn add @m2d/mdast
```
---
## 🚀 Quick Start
```typescript
import type { Checkbox, Fragment, RootContent, SVG } from "@m2d/mdast";
// Strongly-typed extended SVG node
const svgNode: SVG = {
type: "svg",
value: "",
data: {
mermaid: "graph TD; A-->B;",
},
};
// Strongly-typed interactive checkbox node
const checkboxNode: Checkbox = {
type: "checkbox",
checked: true,
};
```
---
## 📚 Deep Dive Guides
- 📐 **[Extended AST Node Specifications Guide](./docs/extended-ast-nodes.mdx)**: Specification details for `SVG`, `Checkbox`, `Fragment`, and block-level table cells.
- 🛑 **[Node Lifecycle & EmptyNode Pattern Guide](./docs/node-lifecycle-and-empty-nodes.mdx)**: Preventing duplicate node compilation and exploring TypeScript helper utilities.
---
## License
This library is licensed under the MIT open-source license.
with 💖 by Mayank Kumar Chaudhari
---
_Source: https://npm.io/package/@mdast2docx/mdast · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
