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

``bash
npm install i markdown-it-emoji
`

Use

$3

`js
//
// { full, light, bare } configs available.
//
// full: includes all available emojis support
// light: includes small subset of most useable emojis
// bare: no defaults
//
// Also CJS & UMD builds available in dist/ folder of published package,
// if your env not supports ESM modules use.
//
import { full as emoji } from 'markdown-it-emoji'
import markdownit from 'markdown-it'

const 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.

$3

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):

`js
// ...
// initialize

md.renderer.rules.emoji = function(token, idx) {
return '';
};
`

Or use twemoji:

`js
// ...
// initialize

import twemoji from 'twemoji'

md.renderer.rules.emoji = function(token, idx) {
return twemoji.parse(token[idx].content);
};
`

__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:

`css
.emoji {
height: 1.2em;
}
`

$3

`md
Hello from mars :satellite:
`

becomes

`
Hello from mars 📡
``