{"library":"markdown-it-emoji","title":"markdown-it Emoji Plugin","description":"markdown-it-emoji is a plugin for the `markdown-it` markdown parser, providing comprehensive support for emoji and emoticon syntax. It parses both standard Unicode emoji shortcodes (e.g., `:smile:`) and common emoticons (e.g., `:)`, `:-(`), converting them into their respective Unicode characters by default. The current stable version is 3.0.0. While no explicit release cadence is stated, it follows the `markdown-it` ecosystem, generally releasing new major versions to align with significant changes or improvements. Key differentiators include its tight integration with `markdown-it`'s plugin architecture, offering configurable emoji sets (full, light, bare), and allowing custom rendering functions for integration with libraries like Twemoji or custom icon fonts. It handles both ESM and CommonJS environments, with specific export changes introduced in v3.","language":"javascript","status":"active","last_verified":"Sun Apr 19","install":{"commands":["npm install markdown-it-emoji"],"cli":null},"imports":["import { full as emoji } from 'markdown-it-emoji'","import markdownit from 'markdown-it'","import twemoji from 'twemoji'"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import markdownit from 'markdown-it';\nimport { full as emoji } from 'markdown-it-emoji';\n\n// Initialize markdown-it with the emoji plugin\nconst md = markdownit().use(emoji, {\n  // Example: Customize shortcuts\n  shortcuts: {\n    \"hello_world\": [\":hi:\", \":wave:\"]\n  }\n});\n\n// Markdown content with emojis and custom shortcuts\nconst markdownContent = `\nHello from mars :satellite:!\nI'm so happy :smile:.\nLet's wave: :hi: :wave:.\n`;\n\n// Render the markdown to HTML\nconst htmlOutput = md.render(markdownContent);\n\nconsole.log(htmlOutput);\n\n// Expected output for :satellite:, :smile:, :hi:, :wave:\n// <p>Hello from mars 📡!\n// I'm so happy 😊.\n// Let's wave: 👋 👋.</p>","lang":"typescript","description":"Demonstrates initializing `markdown-it` with the `markdown-it-emoji` plugin, using the `full` emoji set, and rendering a markdown string containing both standard and custom-configured emoticons/emojis.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}