Package Exports
- @m2d/list
Readme
@m2d/list
Emoji shortcode support for
mdast2docx
This plugin adds support for emoji shortcodes (e.g., 😄
, 🚀
) in your Markdown-to-DOCX conversion pipeline. It replaces recognized emoji shortcodes with their corresponding Unicode characters during the MDAST transformation.
✨ Features
- Converts emoji shortcodes to Unicode emojis (e.g.,
🎉
→ 🎉) - Compatible with
@m2d/core
- Works seamlessly within the
mdast2docx
plugin ecosystem - Easy to integrate and lightweight
📦 Installation
pnpm install @m2d/list
or
yarn add @m2d/list
or
npm add @m2d/list
🧠 How It Works
This plugin scans all text nodes for emoji shortcodes (e.g., 🔥
, ✨
) and replaces them with matching Unicode emojis using a predefined emoji JSON mapping.
🔍 Emoji Support
It uses the GitHub-style emoji shortcodes and more — if a shortcode is not recognized, it will remain unchanged.
🛠️ Development
# Clone and install dependencies
git clone https://github.com/md2docx/emoji-plugin
cd emoji-plugin
npm install
# Build / Test / Dev
npm run build
📄 License
Licensed under the MPL-2.0 License.
⭐ Support Us
If you find this useful:
- ⭐ Star mdast2docx on GitHub
- ❤️ Consider sponsoring
Made with 💖 by Mayank Kumar Chaudhari