mdast2docx 0.0.0-beta.0

package/README.md

@@ -0,0 +1,170 @@
+# **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>

package/dist/chunk-KRMGJ4HN.mjs

@@ -0,0 +1,2 @@
+import{a as w,b as p,e as f,f as k,g as I,h as y,j as g,n as R}from"./chunk-O6BHSWEF.mjs";var b=(h,m,u)=>{let d=async(t,i)=>{var r,o,s;let n=new Set(i),c={bold:i.has("strong"),italics:i.has("emphasis"),strike:i.has("delete")},a=(o=t.url)!=null?o:h[(r=t.identifier)==null?void 0:r.toUpperCase()],e=(s=t.alt)!=null?s:a==null?void 0:a.split("/").pop();switch(t.type){case"text":return[new p({text:t.value,...c})];case"break":return[new p({break:1})];case"inlineCode":return[new p({text:t.value,...c,style:"code"})];case"emphasis":case"strong":case"delete":return n.add(t.type),l(t,n);case"link":case"linkReference":return n.add("link"),[a.startsWith("#")?new k({anchor:a,children:await l(t,n)}):new I({link:a,children:await l(t,n)})];case"image":case"imageReference":return[new f({...await u(a),altText:{description:e,name:e,title:e}})];case"footnoteReference":return[new g(m[t.identifier].id)];default:return[new p("")]}},l=async(t,i=new Set)=>{var n;return(await Promise.all((n=t.children)==null?void 0:n.map(c=>d(c,i)))).flat()};return l},S=async(h,m,u,d)=>{let{imageResolver:l,useTitle:t,...i}={...R,...d},n=b(m,u,l),c=async(e,r)=>{let o=[...r],s={};switch(r.includes("list")&&(s.bullet={level:r.filter(P=>P==="list").length-1}),r.includes("blockquote")&&(s.style="Quote"),e.type){case"paragraph":return[new y({...s,children:await n(e)})];case"heading":return[new y({heading:t?e.depth===1?"Title":`Heading${e.depth-1}`:`Heading${e.depth}`,children:await n(e)})];case"code":return[new y({alignment:"start",style:"blockCode",children:e.value.split(`
+`).map(P=>new p({text:P,break:1,style:"code"}))})];case"list":case"blockquote":case"listItem":return o.push(e.type),a(e,o);case"thematicBreak":return[new y({border:{top:{style:w.SINGLE,size:6}}})];case"table":case"tableRow":case"tableCell":case"yaml":case"html":default:return console.warn(`Unsupported node type: ${e.type}`,e),[]}},a=async(e,r)=>{var o;return(await Promise.all((o=e.children)==null?void 0:o.map(s=>c(s,r)))).flat()};return{...i,children:await a(h,[])}};export{S as a};