[Feature Request] Custom emoji support

[guoyunhe]

In many forum and chat apps, you are able to create your own emojis, like

And you can have your own short code:

:parrot:

Configuration will be like:

remark().use(emoji, {
  customEmojis: {
    parrot: '![Parrot](https://cultofthepartyparrot.com/parrots/parrot.gif)'
  }
});

[rhysd]

I reopened this issue ticket since #31 was reverted.

[rhysd]

Since remark is essentially a transformation from Markdown AST to HTML AST, it is difficult to provide APIs which allow to specify raw Markdown or HTML sources (if we do, we need to parse the sources into AST nodes in advance).

Configuration like below would be easier, but I'm not sure it is useful (since I don't have use case to provide custom emoijs).

remark().use(emoji, {
  customEmojis: {
    parrot: {
      src: 'https://cultofthepartyparrot.com/parrots/parrot.gif', // "src" of <img> (requried)
      aria: 'rainbow parrot', // aria label for accessibility (optional)
    }
  }
});