unified

Project: rhysd/remark-emoji

Package: remark-emoji@2.1.0

  1. Dependencies: 3ยทDependents: 90
  2. Emoji transformer plugin for Remark
  1. remark 175
  2. plugin 130
  3. markdown 111
  4. emoji 5

remark-emoji

Build Status

This is a remark plugin to replace :emoji: to real UTF-8 emojis in text.

Demo

You can find a demo in the following Codesandbox.

Usage

remark().use(emoji [, options]);
const remark = require('remark');
const emoji = require('remark-emoji');

const doc = 'Emojis in this text will be replaced: :dog: :+1:';
console.log(remark().use(emoji).process(doc).contents);
// => Emojis in this text will be replaced: ๐Ÿถ ๐Ÿ‘

Options

options.padSpaceAfter

Setting to true means that an extra whitespace is added after emoji. This is useful when browser handle emojis with half character length and following character is hidden. Default value is false.

options.emoticon

Setting to true means that emoticon shortcodes are supported (e.g. :-) will be replaced by ๐Ÿ˜ƒ). Default value is false.

License

Distributed under the MIT License.