Merge pull request #1 from md2docx/image

Image

Author: mayank1513

.github/workflows/manual-publish.yml

@@ -33,8 +33,8 @@ jobs:
         working-directory: ./lib
       - name: clean up working directory
         run: git status && git clean -f -d && git status
-      # - name: Copy Readme file
-      # run: cp ./README.md ./lib # todo: uncomment this line while rebranding
+      - name: Copy Readme file
+        run: cp ./README.md ./lib # todo: uncomment this line while rebranding
       - name: Apply changesets, publish and create release, branches and tags
         run: node ./scripts/manual-publish.js
         env:

.github/workflows/publish.yml

@@ -35,8 +35,8 @@ jobs:
       - name: Test
         run: pnpm test
         working-directory: ./lib
-      # - name: Copy Readme file
-      # run: cp ./README.md ./lib # will be uncommented while rebranding
+      - name: Copy Readme file
+        run: cp ./README.md ./lib # will be uncommented while rebranding
       - name: Apply changesets, publish and create release, branches and tags
         run: node ./scripts/publish.js
         env:

.tkb

@@ -1,31 +1,6 @@
 {
   "scope": "Workspace",
   "tasks": {
-    "55DAZwduwTvlaxaJC8hlX": {
-      "id": "55DAZwduwTvlaxaJC8hlX",
-      "description": "(Optional) Set up [Deepsource](https://app.deepsource.com/login) for static code analysis",
-      "columnId": "column-todo"
-    },
-    "FDFqCQvLm2mUlnTJ3Gna5": {
-      "id": "FDFqCQvLm2mUlnTJ3Gna5",
-      "description": "Push your changes/Create PR and see your library being automatically tested and published",
-      "columnId": "column-todo"
-    },
-    "O1qAByMoxhHOR-a_guL91": {
-      "id": "O1qAByMoxhHOR-a_guL91",
-      "description": "Optionally deploy your examples to Vercel.",
-      "columnId": "column-todo"
-    },
-    "0499BqWDwJ5cxqtC9Nr82": {
-      "id": "0499BqWDwJ5cxqtC9Nr82",
-      "description": "Feel free to star this template, contribute, and/or sponsor the [`terborepo-template`](https://github.com/md2docx/md2docx-plugin-template) project or my [other open-source work](https://github.com/sponsors/mayank1513)",
-      "columnId": "column-todo"
-    },
-    "IjuAtNquJ4-Ut874rHKIW": {
-      "id": "IjuAtNquJ4-Ut874rHKIW",
-      "description": "You can also fork the [`terborepo-template`](https://github.com/md2docx/md2docx-plugin-template/fork) and add your package to `scripts/featured.json`\n  - If approved, your package will be automatically added to FEATURED.md and also published on the home page of this repo.",
-      "columnId": "column-todo"
-    },
     "_JiH9RZLmUF5nxD7lBC5B": {
       "id": "_JiH9RZLmUF5nxD7lBC5B",
       "description": "Create a new GitHub repository using this template.\n  - Click the `Use this template` button at the top right -> `Create a new repository`\n  - Click `Create repository` and wait for the setup workflow to finish rebranding your repo.",
@@ -46,13 +21,7 @@
     {
       "id": "column-todo",
       "title": "To do",
-      "tasksIds": [
-        "55DAZwduwTvlaxaJC8hlX",
-        "FDFqCQvLm2mUlnTJ3Gna5",
-        "O1qAByMoxhHOR-a_guL91",
-        "0499BqWDwJ5cxqtC9Nr82",
-        "IjuAtNquJ4-Ut874rHKIW"
-      ]
+      "tasksIds": []
     },
     {
       "id": "column-doing",
@@ -69,4 +38,4 @@
       ]
     }
   ]
-}
+}

README.md

@@ -1,82 +1,81 @@
-## 🧩 Plugin Template for `mdast2docx` & `@m2d/remark-docx` <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 40px"/>
+# @m2d/image
 
-[![test](https://github.com/md2docx/md2docx-plugin-template/actions/workflows/test.yml/badge.svg)](https://github.com/md2docx/md2docx-plugin-template/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/md2docx/md2docx-plugin-template/maintainability) [![codecov](https://codecov.io/gh/md2docx/md2docx-plugin-template/graph/badge.svg)](https://codecov.io/gh/md2docx/md2docx-plugin-template) [![Version](https://img.shields.io/npm/v/@m2d/emoji.svg?colorB=green)](https://www.npmjs.com/package/@m2d/emoji) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/@m2d/emoji.svg)](https://www.npmjs.com/package/@m2d/emoji) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@m2d/emoji)
+[![test](https://github.com/md2docx/image/actions/workflows/test.yml/badge.svg)](https://github.com/md2docx/image/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/md2docx/image/maintainability) [![codecov](https://codecov.io/gh/md2docx/image/graph/badge.svg)](https://codecov.io/gh/md2docx/image) [![Version](https://img.shields.io/npm/v/@m2d/image.svg?colorB=green)](https://www.npmjs.com/package/@m2d/image) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/@m2d/image.svg)](https://www.npmjs.com/package/@m2d/image) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@m2d/image)
 
-> This repository serves as a starting point for building plugins that extend the functionality of [`mdast2docx`](https://www.npmjs.com/package/mdast2docx), [`@m2d/core`](https://www.npmjs.com/package/@m2d/core) and [`@m2d/remark-docx`](https://www.npmjs.com/package/@m2d/remark-docx).
+> Emoji shortcode support for `mdast2docx`
 
-<details>
-<summary style="cursor:pointer"><h2 style="display:inline-block">Features</h2></summary>
+This plugin adds support for emoji shortcodes (e.g., `:smile:`, `:rocket:`) in your Markdown-to-DOCX conversion pipeline. It replaces recognized emoji shortcodes with their corresponding Unicode characters during the MDAST transformation.
 
-This template offers the following pre-configured features. Additionally, your repository will automatically be re-branded with the help of workflows and post-install scripts.
-
-✅ Monorepo powered by Turborepo and GitHub actions for automating building, testing, and deploying your plugin library
-
-✅ Examples with Next.js, and Vite to showcase how your library can be utilized, also helps in quick manual testing
-
-✅ Examples pre-configured for Light/Dark theme based on user preference
-
-✅ Examples ready to be deployed to Vercel
-
-✅ Code of Conduct and contributing files, ready for customization
+---
 
-✅ Prettier and linter configured according to modern best practices (Feel free to add your flavor)
+## ✨ Features
 
-✅ Recommended VSCode extensions - Prettier and [Kanban board](https://github.com/mayank1513/vscode-extension-trello-kanban-board) for code formatting and project management directly within your IDE
+- Converts emoji shortcodes to Unicode emojis (e.g., `:tada:` → 🎉)
+- Compatible with [`@m2d/core`](https://www.npmjs.com/package/@m2d/core)
+- Works seamlessly within the `mdast2docx` plugin ecosystem
+- Easy to integrate and lightweight
 
-✅ Test setup with Vitest - A modern and fast testing framework supporting Jest-like APIs
+---
 
-✅ Workflows to automate testing on every pull-request or code push event
+## 📦 Installation
 
-✅ Workflow to automatically publish and create GitHub releases when you update your library's `package.json` file.
+```bash
+pnpm install @m2d/image
+```
 
-✅ Workflow to automatically rebrand the entire template based on your repository name. (Refer [TODO.md](./TODO.md))
+**_or_**
 
-✅ Plus, this repo includes a quick checklist for configuring Codecov and other badges, setting up your docs website on GitHub pages, and more. See [Checklist](./TODO.md) or open TKB(Workspace) if you have installed the Trello-Kanban-Board extension.
+```bash
+yarn add @m2d/image
+```
 
-</details>
+**_or_**
 
-> <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 20px"/> Star [this repository](https://github.com/md2docx/md2docx-plugin-template) and share it with your friends.
+```bash
+npm add @m2d/image
+```
 
 ---
 
-## Getting Started:
-
-This template is based on [Turborepo Template](https://github.com/react18-tools/turborepo-template/). But this one is optimized for md2docx plugins. It includes pre-configured unit-tests, a lot of extra stuff provided by the turborepo-template is removed, and comes with dependencies and scripts optimized for md2docx plugin development.
+## 🧠 How It Works
 
-To get started, simply click on the `"Use this template"` button to create a new repository based on this template, and install dependencies. Customize it according to your requirements for your next md2docx plugin.
+This plugin scans all text nodes for emoji shortcodes (e.g., `:fire:`, `:sparkles:`) and replaces them with matching Unicode emojis using a predefined emoji JSON mapping.
 
-For detailed instructions and a checklist, please refer to [TODO.md](./TODO.md).
+---
 
-### 🤩 Don't forget to star [this repository](https://github.com/react18-tools/turborepo-template)!
+## 🔍 Emoji Support
 
-Looking for a hands-on course to get started with Turborepo? Check out [React and Next.js with TypeScript](https://mayank-chaudhari.vercel.app/courses/react-and-next-js-with-typescript) and [The Game of Chess with Next.js, React, and TypeScript](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescript/?referralCode=851A28F10B254A8523FE)
+It uses the [GitHub-style emoji shortcodes](https://github.com/ikatyang/emoji-cheat-sheet) and more — if a shortcode is not recognized, it will remain unchanged.
 
 ---
 
-### 🧰 Helpful References
+## 🛠️ Development
 
-- [`@m2d/core`](https://www.npmjs.com/package/@m2d/core) – Core MDAST to DOCX engine
-- [`@m2d/remark-docx`](https://www.npmjs.com/package/@m2d/remark-docx) – Remark plugin
-- [Unified Ecosystem](https://unifiedjs.com) – AST-based processors for markdown, html, etc.
-- [MDAST Spec](https://github.com/syntax-tree/mdast) – Markdown Abstract Syntax Tree
+```bash
+# Clone and install dependencies
+git clone https://github.com/md2docx/emoji-plugin
+cd emoji-plugin
+npm install
+
+# Build / Test / Dev
+npm run build
+```
 
 ---
 
-### 💡 Derive Ideas from existing Plugins
+## 📄 License
 
-- `@m2d/math`: Parse math blocks and convert to equation DOCX
-- `@m2d/image`: Convert Markdown/HTML images to inline DOCX images
-- `@m2d/html`: Parse raw HTML into extended MDAST with styles
-- `@m2d/table`: Advanced table support with merged cells, widths, styles
+Licensed under the **MPL-2.0** License.
 
 ---
 
-### 🙌 Contribute
+## ⭐ Support Us
 
-If you’re building a plugin you'd like to share, let us know or open a PR in the [mdast2docx plugins repo](https://github.com/m2djs/mdast2docx)!
+If you find this useful:
 
-> <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 20px"/> Enrolling in [our courses](https://mayank-chaudhari.vercel.app/courses) or [sponsor](https://github.com/sponsors/mayank1513) our work.
+- ⭐ Star [mdast2docx](https://github.com/md2docx/mdast2docx) on GitHub
+- ❤️ Consider [sponsoring](https://github.com/sponsors/mayank1513)
 
-<hr />
+---
 
-<p align="center" style="text-align:center">with 💖 by <a href="https://mayank-chaudhari.vercel.app" target="_blank">Mayank Kumar Chaudhari</a></p>
+<p align="center">Made with 💖 by <a href="https://mayank-chaudhari.vercel.app" target="_blank">Mayank Kumar Chaudhari</a></p>

SECURITY.md

@@ -20,4 +20,4 @@ Note: We only accept pull requests addressing security vulnerabilities. Addition
 
 ## Reporting Vulnerabilities
 
-Kindly report vulnerabilities [here](https://github.com/md2docx/md2docx-plugin-template/security/advisories/new).
+Kindly report vulnerabilities [here](https://github.com/md2docx/image/security/advisories/new).

TODO.md

@@ -12,13 +12,13 @@
 - [ ] Install dependencies using `pnpm`
   - Run `pnpm i` to install dependencies
 - [ ] Make sure you run `pnpm rebrand` from the root directory to rebrand your repo.
-- [ ] 🌟 Enable [private vulnerability reporting]
+- [ ] 🌟 Enable [private vulnerability reporting](https://github.com/md2docx/image/security)
 - [ ] Set up `CodeCov`
   - Visit Codecov and set up your repo
-  - Create [repository secret] for `CODECOV_TOKEN`
+  - Create [repository secret]((https://github.com/md2docx/image/settings/secrets/actions)) for `CODECOV_TOKEN`
 - [ ] Set up `CodeClimate`
   - Visit CodeClimate and set up your repo
-  - Create [repository secret] for `CC_TEST_REPORTER_ID`
+  - Create [repository secret]((https://github.com/md2docx/image/settings/secrets/actions)) for `CC_TEST_REPORTER_ID`
   - Add `*.test.*` to ignore patterns on the website
   - Update Code Climate badge
 - [ ] Add `NPM_AUTH_TOKEN` to repository secrets to automate package publishing

examples/nextjs/package.json

@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@m2d/core": "latest",
-    "@m2d/emoji": "workspace:*",
+    "@m2d/emoji": "latest",
     "@repo/shared": "workspace:*",
     "mdast2docx": "0.3.0",
     "next": "^15.2.3",
@@ -27,7 +27,8 @@
     "remark-math": "^6.0.0",
     "remark-parse": "^11.0.0",
     "unified": "^11.0.5",
-    "webgl-generative-particles": "^0.0.1"
+    "webgl-generative-particles": "^0.0.1",
+    "@m2d/image": "workspace:*"
   },
   "devDependencies": {
     "@next/eslint-plugin-next": "^15.2.3",
@@ -38,4 +39,4 @@
     "@types/react-dom": "^19.0.4",
     "typescript": "^5.8.2"
   }
-}
+}

examples/vite/package.json

@@ -20,7 +20,8 @@
     "react18-loaders": "latest",
     "react18-themes": "^3.2.0",
     "@m2d/core": "latest",
-    "@m2d/emoji": "workspace:*"
+    "@m2d/emoji": "latest",
+    "@m2d/image": "workspace:*"
   },
   "devDependencies": {
     "@repo/eslint-config": "workspace:*",
@@ -31,4 +32,4 @@
     "typescript": "^5.8.2",
     "vite": "^6.2.2"
   }
-}
+}