npmpackage.info

markdown-it-emoji

Emoji syntax plugin for markdown-it markdown parser

3.0.0

734

MIT

JavaScript

16.50 kB

73,662,550 4.2

Installations

npm install markdown-it-emoji

Developer Guide

BETA

Typescript

No

Module System

CommonJS, ESM

Node Version

18.14.1

NPM Version

9.3.1 Score

99.6

Supply Chain

99.6

Quality

75.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

13

Closed

6

Merged

5

Issues

Open

3

Total

42

Closed

39

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 7 Contributors

Languages

JavaScript

JavaScript (100%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

markdown-it

Download Statistics

Total Downloads

73,662,550

Last Day

70,745

Last Week

402,767

Last Month

1,631,157

Last Year

17,247,362

GitHub Statistics

MIT License

734 Stars

79 Commits

168 Forks

9 Watchers

2 Branches

7 Contributors

Updated on Jan 18, 2025

Bundle Size

42.99 kB

Minified

16.50 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

3.0.0

Package Id

markdown-it-emoji@3.0.0

Unpacked Size

336.34 kB

Size

98.03 kB

File Count

NPM Version

9.3.1

Node Version

18.14.1

Published on

Dec 07, 2023

Total Downloads

Cumulative downloads

Total Downloads

73,662,550

Last Day

3.6%

70,745

Compared to previous day

Last Week

9.4%

402,767

Compared to previous week

Last Month

30.6%

1,631,157

Compared to previous month

Last Year

-5.7%

17,247,362

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@rollup/plugin-babel @rollup/plugin-node-resolve @rollup/plugin-terser c8 eslint eslint-config-standard markdown-it markdown-it-testgen mocha rollup

markdown-it-emoji

Plugin for markdown-it markdown parser, adding emoji & emoticon syntax support. Also supports emoticons shortcuts like :), :-(, and others.

NOTE. v3 changed exports, see below.

Install

1npm install i markdown-it-emoji

Use

init

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:

defs (Object) - rewrite available emoji definitions
- example: { name1: char1, name2: char2, ... }
enabled (Array) - disable all emojis except whitelisted
shortcuts (Object) - rewrite default shortcuts
- example: { "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.

change output

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}

In your markdown file

1Hello from mars :satellite:

becomes

Hello from mars 📡

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.2

/10

Last Scanned on 2025-02-03

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

Other packages similar to markdown-it-emoji

@types/markdown-it-emoji

3.0.1

TypeScript definitions for markdown-it-emoji

markdown-it-icons

0.4.1

Plugin for markdown-it, supports emoji icons and font-awesome icons.

markdown-it-emoji-mart

0.1.1

Emoji-mart supported emojis plugin for markdown-it markdown parser.

@gerhobbelt/markdown-it-emoji

2.0.0-12

Emoji plugin for markdown-it markdown parser.