markdown-it-emoji
Plugin for markdown-it markdown parser, adding emoji & emoticon syntax support.
v1.+ requires markdown-it
v4.+, see changelog.
Two versions:
- Full (default), with all github supported emojis.
- Light, with only well-supported unicode emojis and reduced size.
Also supports emoticons shortcuts like :)
, :-(
, and others. See the full list in the link above.
Install
node.js, browser:
npm install markdown-it-emoji --savebower install markdown-it-emoji --save
Use
init
var md = ;var emoji = ;// Or for light version// var emoji = require('markdown-it-emoji/light'); md;
Options are not mandatory:
- defs (Object) - rewrite available emoji definitions
- example:
{ name1: char1, name2: char2, ... }
- example:
- enabled (Array) - disable all emojis except whitelisted
- shortcuts (Object) - rewrite default shortcuts
- example:
{ "smile": [ ":)", ":-)" ], "laughing": ":D" }
- example:
- renderer (String) - Can be unicode (default), twemoji or span
- example:
"renderer": "span", "span_class_prefix": "emoji emoji_"
- example:
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:
var md = window;
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: