Gathering detailed insights and metrics for markdown-it-emoji
Gathering detailed insights and metrics for markdown-it-emoji
Gathering detailed insights and metrics for markdown-it-emoji
Gathering detailed insights and metrics for markdown-it-emoji
@types/markdown-it-emoji
TypeScript definitions for markdown-it-emoji
markdown-it-icons
Plugin for markdown-it, supports emoji icons and font-awesome icons.
markdown-it-emoji-mart
Emoji-mart supported emojis plugin for markdown-it markdown parser.
@gerhobbelt/markdown-it-emoji
Emoji plugin for markdown-it markdown parser.
Emoji syntax plugin for markdown-it markdown parser
npm install markdown-it-emoji
Typescript
Module System
Node Version
NPM Version
99.6
Supply Chain
99.6
Quality
75.6
Maintenance
100
Vulnerability
100
License
JavaScript (100%)
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
MIT License
747 Stars
79 Commits
170 Forks
8 Watchers
2 Branches
7 Contributors
Updated on Jul 03, 2025
Latest Version
3.0.0
Package Id
markdown-it-emoji@3.0.0
Unpacked Size
336.34 kB
Size
98.03 kB
File Count
23
NPM Version
9.3.1
Node Version
18.14.1
Published on
Dec 07, 2023
Cumulative downloads
Total Downloads
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Plugin for markdown-it markdown parser, adding emoji & emoticon syntax support. Also supports emoticons shortcuts like
:)
,:-(
, and others.
NOTE. v3 changed exports, see below.
1npm install i markdown-it-emoji
1// 2// { full, light, bare } configs available. 3// 4// full: includes all available emojis support 5// light: includes small subset of most useable emojis 6// bare: no defaults 7// 8// Also CJS & UMD builds available in `dist/` folder of published package, 9// if your env not supports ESM modules use. 10// 11import { full as emoji } from 'markdown-it-emoji' 12import markdownit from 'markdown-it' 13 14const md = markdownit().use(emoji/* , options */);
Options are not mandatory:
{ name1: char1, name2: char2, ... }
{ "smile": [ ":)", ":-)" ], "laughing": ":D" }
Differences in browser. If you load the script directly into the page without
using a package system, the module will add itself globally with the name markdownitEmoji
.
By default, emojis are rendered as appropriate unicode chars. But you can change the renderer function as you wish.
Render as span blocks (for example, to use a custom iconic font):
1// ... 2// initialize 3 4md.renderer.rules.emoji = function(token, idx) { 5 return '<span class="emoji emoji_' + token[idx].markup + '"></span>'; 6};
Or use twemoji:
1// ... 2// initialize 3 4import twemoji from 'twemoji' 5 6md.renderer.rules.emoji = function(token, idx) { 7 return twemoji.parse(token[idx].content); 8};
NB 1. Read twemoji docs! In case you need more options to change image size & type.
NB 2. When using twemoji you can make image height match the line height with this style:
1.emoji { 2 height: 1.2em; 3}
1Hello from mars :satellite:
becomes
Hello from mars 📡
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
Reason
security policy file detected
Details
Reason
Found 3/28 approved changesets -- score normalized to 1
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More