https://github.com/sgpinkus/remark-emoji

Remark markdown transformer to replace :emoji: in text
https://github.com/sgpinkus/remark-emoji

emoji remark remark-emoji unist

Last synced: 2 months ago
JSON representation

Remark markdown transformer to replace :emoji: in text

• Host: GitHub
• URL: https://github.com/sgpinkus/remark-emoji
• Owner: sgpinkus
• License: mit
• Fork: true (rhysd/remark-emoji)
• Created: 2020-08-24T07:09:07.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-17T10:02:32.000Z (about 2 years ago)
• Last Synced: 2024-04-24T16:58:52.221Z (8 months ago)
• Topics: emoji, remark, remark-emoji, unist
• Language: JavaScript
• Homepage:
• Size: 144 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# remark-emoji

*Forked from remark-emoji and rewritten for better emoticon parsing. API Compatible.*

This is a [remark](https://github.com/wooorm/remark) plugin to replace `:emoji:` to real UTF-8 emojis in text.

## Demo

You can find a demo in the following [Codesandbox](https://codesandbox.io/s/remark-emoji-example-osvyi).

## Usage

```

remark().use(emoji [, options]);

```

```javascript

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](https://www.npmjs.com/package/emoticon) shortcodes are supported (e.g. :-) will be replaced by 😃). Default value is `false`.

## License

Distributed under [the MIT License](LICENSE).