Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

@gera2ld/gatsby-remark-emoji

NPM License Downloads

This is a plugin for gatsby-plugin-remark to replace :emoji: short names with UTF-8 emoji icons.

It utilizes emoji-js under the hood.

Installation

$ npm i @gera2ld/gatsby-remark-emoji

Usage

Add to gatsby-config.js:

  plugins: [      
    '@gera2ld/gatsby-remark-emoji',
  ]

  // or

  plugins: [      
    {
      resolve: '@gera2ld/gatsby-remark-emoji',
      options, // see below
    },
  ]

Options

Options will be assigned to EmojiConvertor instance, roughly the same as:

const emoji = new EmojiConvertor();
Object.assign(emoji, pluginOptions);

See emoji-js for more details.

The default options are:

{
  replace_mode: 'unified',
}
© 2023 Gatsby, Inc.