Installations

npm install @gerhobbelt/markdown-it-emoji

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=12.20.0

Node Version

16.4.1

NPM Version

7.19.1 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

1

Unable to fetch Contributors

View All 1 Contributors

Languages

2

JavaScript

Makefile

JavaScript (86.1%)

Makefile (13.9%)

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

Developer

GerHobbelt

Download Statistics

Total Downloads

4,713

Last Day

1

Last Week

6

Last Month

63

Last Year

522

GitHub Statistics

MIT License

3 Stars

96 Commits

1 Forks

2 Watchers

1 Branches

1 Contributors

Updated on Feb 07, 2022

Maintainers

1

Package Meta Information

Latest Version

2.0.0-12

Package Id

@gerhobbelt/markdown-it-emoji@2.0.0-12

Unpacked Size

104.85 kB

Size

29.67 kB

File Count

26

NPM Version

7.19.1

Node Version

16.4.1

Total Downloads

Cumulative downloads

Total Downloads

4,713

Last Day

-50%

1

Compared to previous day

Last Week

-60%

6

Compared to previous week

Last Month

320%

63

Compared to previous month

Last Year

-36.3%

522

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

8

@gerhobbelt/markdown-it @gerhobbelt/markdown-it-testgen @gerhobbelt/prepend-header cross-env eslint microbundle mocha nyc

markdown-it-emoji

Plugin for markdown-it markdown parser, adding emoji & emoticon syntax support.

v1.+ requires markdown-it v4.+, see changelog.

Three versions:

Full (default), with all github supported emojis.
Light, with only well-supported unicode emojis and reduced size.
Bare, without included emojis or shortcuts. This requires defining your own definitions and shortcuts.

Also supports emoticons shortcuts like :), :-(, and others. See the full list in the link above.

Install

node.js, browser:

1npm install @gerhobbelt/markdown-it-emoji --save

Use

init

1var md = require('@gerhobbelt/markdown-it')();
2var emoji = require('@gerhobbelt/markdown-it-emoji');
3// Or for light version
4// var emoji = require('@gerhobbelt/markdown-it-emoji/light');
5
6md.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. Init code will look a bit different in this case:

1var md = window.markdownit().use(window.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
4var twemoji = require('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}

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

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

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-02-10

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