History

divya-mohan0209 9de94a264c Initial commit		2022-09-22 09:54:31 +05:30
..
types	Initial commit	2022-09-22 09:54:31 +05:30
LICENSE	Initial commit	2022-09-22 09:54:31 +05:30
README.md	Initial commit	2022-09-22 09:54:31 +05:30
index.js	Initial commit	2022-09-22 09:54:31 +05:30
package.json	Initial commit	2022-09-22 09:54:31 +05:30

README.md

remark-emoji

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.