mdast2docx 0.0.0-beta.0 → 0.1.0

package/README.md

@@ -1,170 +1,203 @@
-# **MDAST (Markdown Abstract Syntax Tree) to DOCX** <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 40px"/>
-
-🚀 **Effortlessly convert Markdown Abstract Syntax Trees (MDAST) to DOCX.**
-
-[![Test](https://github.com/tiny-md/mdast2docx/actions/workflows/test.yml/badge.svg)](https://github.com/tiny-md/mdast2docx/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/tiny-md/mdast2docx/maintainability) [![Code Coverage](https://codecov.io/gh/tiny-md/mdast2docx/graph/badge.svg)](https://codecov.io/gh/tiny-md/mdast2docx) [![Version](https://img.shields.io/npm/v/mdast2docx.svg?colorB=green)](https://www.npmjs.com/package/mdast2docx) [![Downloads](https://img.shields.io/npm/d18m/mdast2docx)](https://www.npmjs.com/package/mdast2docx) ![Bundle Size](https://img.shields.io/bundlephobia/minzip/mdast2docx)
-
----
-
-## **✨ Features**
-
-✅ **MDAST to DOCX conversion** — Supports standard Markdown elements  
-✅ **Footnotes handling** — Converts Markdown footnotes to DOCX format  
-✅ **Customizable image handling** — Fine-tune image rendering in DOCX  
-✅ **Hyperlink support** — Converts external links, internal links [WIP]  
-✅ **Configurable sections** — Customize document structure & styling
-
----
-
-## **📦 Installation**
-
-Install the package using `pnpm`, `npm`, or `yarn`:
-
-```bash
-pnpm add mdast2docx
-```
-
-**_or_**
-
-```bash
-npm install mdast2docx
-```
-
-**_or_**
-
-```bash
-yarn add mdast2docx
-```
-
----
-
-## **🚀 Usage**
-
-### **Basic Example**
-
-```typescript
-import { toDocx } from "mdast2docx";
-import { unified } from "unified";
-import remarkParse from "remark-parse";
-import remarkMmd from "remark-mmd"; // Assumed MMD plugin
-
-const markdown = `
-# Sample Document  
-This is a **bold** text and _italic_ text.  
-
-> A blockquote example  
-
-- List Item 1  
-- List Item 2  
-
-[Click Here](https://example.com)  
-
-![Sample Image](https://example.com/image.png)  
-
-This is a footnote reference[^1].  
-
-[^1]: This is the footnote content.
-`;
-
-const mdast = unified().use(remarkParse).use(remarkMmd).parse(markdown);
-
-(async () => {
-  const docxBlob = await toDocx(mdast, { title: "My Document" }, {});
-  const url = URL.createObjectURL(docxBlob as Blob);
-  const link = document.createElement("a");
-  link.href = url;
-  link.download = "document.docx";
-  link.click();
-  URL.revokeObjectURL(url);
-})();
-```
-
----
-
-## **🛠 API Reference**
-
-### **`toDocx(astInputs, docxProps, defaultSectionProps, outputType?)`**
-
-| Parameter                 | Type                                               | Description                                                      |
-| ------------------------- | -------------------------------------------------- | ---------------------------------------------------------------- |
-| `astInputs`               | `Root` \| `{ ast: Root; props?: ISectionProps }[]` | Single or multiple MDAST trees with optional section properties. |
-| `docxProps`               | `IDocxProps`                                       | General document properties (title, styles, metadata).           |
-| `defaultSectionProps`     | `ISectionProps`                                    | Default properties for document sections.                        |
-| `outputType` _(optional)_ | `"blob"` (default) \| `"buffer"` \| `"base64"`     | Format of the generated DOCX document.                           |
-
-📌 **Returns:** A `Promise` resolving to a DOCX document in the chosen format.
-
----
-
-## **📜 Supported Markdown Elements**
-
-| Markdown Syntax                    | Supported in DOCX      |
-| ---------------------------------- | ---------------------- |
-| Headings `# H1` to `###### H6`     | ✅                     |
-| Paragraphs                         | ✅                     |
-| Bold `**text**` & Italics `_text_` | ✅                     |
-| Blockquotes `> quote`              | ✅                     |
-| Lists (ordered & unordered)        | ✅                     |
-| Links `[text](url)`                | ✅                     |
-| Images `![alt](url)`               | ✅                     |
-| Code Blocks `` `code` ``           | ✅                     |
-| Footnotes `[^1]`                   | ✅                     |
-| Tables                             | 🚧 _(Coming soon)_     |
-| HTML Tags                          | 🚧 _(Partial support)_ |
-
----
-
-## **🔧 Configuration**
-
-You can customize the DOCX output using `ISectionProps` and `IDocxProps`.
-
-### **Example: Customizing Styles**
-
-```typescript
-const docxProps = {
-  title: "Styled Document",
-  author: "John Doe",
-};
-
-const sectionProps = {
-  page: { margin: { top: 1000, bottom: 1000, left: 1200, right: 1200 } },
-};
-
-const docxBlob = await toDocx(mdast, docxProps, sectionProps);
-```
-
-📖 **More details:**
-
-- [DOCX.js Document Properties](https://docx.js.org/#/usage/document)
-- [DOCX.js Section Options](https://docx.js.org/#/usage/sections)
-
----
-
-## **📝 Contributing**
-
-We welcome contributions! To get started:
-
-1. **Fork** the repository
-2. **Create a feature branch** (`git checkout -b feature-new`)
-3. **Commit your changes** (`git commit -m "Add new feature"`)
-4. **Push to GitHub** (`git push origin feature-new`)
-5. **Open a Pull Request** 🚀
-
----
-
-## **📄 License**
-
-This project is **licensed under MPL-2.0**. See the [LICENSE](./LICENSE) file for details.
-
----
-
-## **🙌 Acknowledgments**
-
-Thanks to the **docx.js** and **unified.js** ecosystems for making this possible.
-
-> ⭐ **Star this repository** if you find it useful!  
-> ❤️ Support our work by [sponsoring](https://github.com/sponsors/mayank1513).
-
----
-
-<p align="center">Made with 💖 by <a href="https://mayank-chaudhari.vercel.app" target="_blank">Mayank Kumar Chaudhari</a></p>
+# **MDAST (Markdown Abstract Syntax Tree) to DOCX** <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 40px"/>
+
+🚀 **Effortlessly convert Markdown Abstract Syntax Trees (MDAST) to DOCX.**
+
+[![Test](https://github.com/tiny-md/mdast2docx/actions/workflows/test.yml/badge.svg)](https://github.com/tiny-md/mdast2docx/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/tiny-md/mdast2docx/maintainability) [![Code Coverage](https://codecov.io/gh/tiny-md/mdast2docx/graph/badge.svg)](https://codecov.io/gh/tiny-md/mdast2docx) [![Version](https://img.shields.io/npm/v/mdast2docx.svg?colorB=green)](https://www.npmjs.com/package/mdast2docx) [![Downloads](https://img.shields.io/npm/d18m/mdast2docx)](https://www.npmjs.com/package/mdast2docx) ![Bundle Size](https://img.shields.io/bundlephobia/minzip/mdast2docx)
+
+---
+
+## **✨ Features**
+
+✅ **MDAST to DOCX conversion** — Supports standard Markdown elements  
+✅ **Footnotes handling** — Converts Markdown footnotes to DOCX format  
+✅ **Tables support** — Converts Markdown tables into DOCX tables  
+✅ **Hyperlink support** — External and internal hyperlinks are now fully functional  
+✅ **New Plugin Architecture** — Extend and customize DOCX output with plugins  
+✅ **Customizable image handling** — Images are now supported via `imagePlugin`
+
+> **Note:** Images are no longer supported by default. To enable image support, use the `imagePlugin` explicitly.
+>
+> This change helps us keep the library lean and extensible by community via plugins.
+
+---
+
+## **📦 Installation**
+
+Install the package using `pnpm`, `npm`, or `yarn`:
+
+```bash
+pnpm add mdast2docx
+```
+
+**_or_**
+
+```bash
+npm install mdast2docx
+```
+
+**_or_**
+
+```bash
+yarn add mdast2docx
+```
+
+---
+
+## **🚀 Usage**
+
+### **Basic Example**
+
+```typescript
+import { toDocx } from "mdast2docx";
+import { unified } from "unified";
+import remarkParse from "remark-parse";
+import remarkMmd from "remark-mmd"; // Assumed MMD plugin
+
+const markdown = `
+# Sample Document  
+This is a **bold** text and _italic_ text.  
+
+> A blockquote example  
+
+- List Item 1  
+- List Item 2  
+
+[Click Here](https://example.com)  
+
+This is a footnote reference[^1].  
+
+[^1]: This is the footnote content.
+`;
+
+const mdast = unified().use(remarkParse).use(remarkMmd).parse(markdown);
+
+(async () => {
+  const docxBlob = await toDocx(mdast, { title: "My Document" }, {});
+  const url = URL.createObjectURL(docxBlob as Blob);
+  const link = document.createElement("a");
+  link.href = url;
+  link.download = "document.docx";
+  link.click();
+  URL.revokeObjectURL(url);
+})();
+```
+
+---
+
+## **📜 API Reference**
+
+### **`toDocx(astInputs, docxProps, defaultSectionProps, outputType?)`**
+
+| Parameter                 | Type                                               | Description                                                      |
+| ------------------------- | -------------------------------------------------- | ---------------------------------------------------------------- |
+| `astInputs`               | `Root` \| `{ ast: Root; props?: ISectionProps }[]` | Single or multiple MDAST trees with optional section properties. |
+| `docxProps`               | `IDocxProps`                                       | General document properties (title, styles, metadata).           |
+| `defaultSectionProps`     | `ISectionProps`                                    | Default properties for document sections.                        |
+| `outputType` _(optional)_ | `"blob"` (default) \| `"buffer"` \| `"base64"`     | Format of the generated DOCX document.                           |
+
+📌 **Returns:** A `Promise` resolving to a DOCX document in the chosen format.
+
+---
+
+## **📜 Supported Markdown Elements**
+
+| Markdown Syntax                    | Supported in DOCX                     |
+| ---------------------------------- | ------------------------------------- |
+| Headings `# H1` to `###### H6`     | ✅                                    |
+| Paragraphs                         | ✅                                    |
+| Bold `**text**` & Italics `_text_` | ✅                                    |
+| Blockquotes `> quote`              | ✅                                    |
+| Lists (ordered & unordered)        | ✅ _(ordered lists via `listPlugin`)_ |
+| Links `[text](url)`                | ✅                                    |
+| Images `![alt](url)`               | ✅ _(via `imagePlugin`)_              |
+| Code Blocks `` `code` ``           | ✅                                    |
+| Footnotes `[^1]`                   | ✅                                    |
+| Tables                             | ✅ _(via `tablePlugin`)_              |
+| Hyperlinks (external & internal)   | ✅                                    |
+| HTML Tags                          | 🚧 _(Work in progress)_               |
+
+---
+
+## **🔧 Configuration**
+
+You can customize the DOCX output using `ISectionProps` and `IDocxProps`.
+
+### **Example: Customizing Styles**
+
+```typescript
+const docxProps = {
+  title: "Styled Document",
+  author: "John Doe",
+};
+
+const sectionProps = {
+  page: { margin: { top: 1000, bottom: 1000, left: 1200, right: 1200 } },
+};
+
+const docxBlob = await toDocx(mdast, docxProps, sectionProps);
+```
+
+### **Use Plugins**
+
+Plugins allow extending functionality like adding image or table support.
+
+```typescript
+import { toDocx } from "mdast2docx";
+import { imagePlugin, tablePlugin, listPlugin, mathPlugin } from "mdast2docx/dist/plugins";
+
+const downloadDocx = () => {
+  toDocx(
+    mdast,
+    {},
+    { plugins: [imagePlugin(), tablePlugin(), listPlugin(), mathPlugin()] },
+    "blob",
+  ).then(blob => {
+    const url = URL.createObjectURL(blob as Blob);
+    const link = document.createElement("a");
+    link.href = url;
+    link.download = "my-document.docx";
+    link.click();
+    URL.revokeObjectURL(url);
+  });
+};
+```
+
+📖 **More details:**
+
+- [DOCX.js Document Properties](https://docx.js.org/#/usage/document)
+- [DOCX.js Section Options](https://docx.js.org/#/usage/sections)
+
+---
+
+## **📝 Contributing**
+
+We welcome contributions! To get started:
+
+1. **Fork** the repository
+2. **Create a feature branch** (`git checkout -b feature-new`)
+3. **Commit your changes** (`git commit -m "Add new feature"`)
+4. **Push to GitHub** (`git push origin feature-new`)
+5. **Open a Pull Request** 🚀
+
+### **Extend Functionality with Plugins**
+
+The community can create plugins to extend the functionality of this library. For inspiration, check out the existing plugins in the [`lib/src/plugins`](https://github.com/tiny-md/mdast2docx/tree/main/lib/src/plugins) folder.
+
+---
+
+## **📄 License**
+
+This project is **licensed under MPL-2.0**. See the [LICENSE](./LICENSE) file for details.
+
+---
+
+## **🙌 Acknowledgments**
+
+Thanks to the **docx.js** and **unified.js** ecosystems for making this possible.
+
+> ⭐ **Star this repository** if you find it useful!  
+> ❤️ Support our work by [sponsoring](https://github.com/sponsors/mayank1513).
+
+---
+
+<p align="center">Made with 💖 by <a href="https://mayank-chaudhari.vercel.app" target="_blank">Mayank Kumar Chaudhari</a></p>

package/dist/chunk-3ZZBJC3M.mjs

@@ -0,0 +1 @@
+var i=Object.create;var f=Object.defineProperty;var j=Object.getOwnPropertyDescriptor;var k=Object.getOwnPropertyNames;var l=Object.getPrototypeOf,m=Object.prototype.hasOwnProperty;var g=a=>{throw TypeError(a)};var o=(a=>typeof require!="undefined"?require:typeof Proxy!="undefined"?new Proxy(a,{get:(b,c)=>(typeof require!="undefined"?require:b)[c]}):a)(function(a){if(typeof require!="undefined")return require.apply(this,arguments);throw Error('Dynamic require of "'+a+'" is not supported')});var p=(a,b)=>()=>(b||a((b={exports:{}}).exports,b),b.exports);var n=(a,b,c,d)=>{if(b&&typeof b=="object"||typeof b=="function")for(let e of k(b))!m.call(a,e)&&e!==c&&f(a,e,{get:()=>b[e],enumerable:!(d=j(b,e))||d.enumerable});return a};var q=(a,b,c)=>(c=a!=null?i(l(a)):{},n(b||!a||!a.__esModule?f(c,"default",{value:a,enumerable:!0}):c,a));var h=(a,b,c)=>b.has(a)||g("Cannot "+c);var r=(a,b,c)=>(h(a,b,"read from private field"),c?c.call(a):b.get(a)),s=(a,b,c)=>b.has(a)?g("Cannot add the same private member more than once"):b instanceof WeakSet?b.add(a):b.set(a,c),t=(a,b,c,d)=>(h(a,b,"write to private field"),d?d.call(a,c):b.set(a,c),c);export{o as a,p as b,q as c,r as d,s as e,t as f};