[DEPRECATED] gatsby-remark-a11y-emoji
This plugin is now directly included in @fec/remark-a11y-emoji.
Gatsby Plugin to make Emoji in Markdown accessible. Wraps Emoji in a
<span>
-Tag withrole
andaria-label
attributes.
Made by
Table of Contents
Motivation
Everyone loves emoji span
and add role="img"
and aria-label
attributes.
This plugin does this automatically for you.
Gatsby is 💯
will turn into
Gatsby is <span role="img" aria-label="hundred points">💯</span>
Requirements
- Node >=10.13.0 (same as Gatsby)
Installation
First you need to install the plugin with NPM or Yarn:
npm install --save gatsby-remark-a11y-emoji
Add the plugin to gatsby-config.js
. Since gatsby-remark-a11y-emoji
converts Remark text nodes into html nodes, I recommend placing it at the very end of the plugins list.
module.exports = {
// ...
plugins: [
{
resolve: `gatsby-transformer-remark`,
options: {
plugins: [
// ...
'gatsby-remark-a11y-emoji',
],
},
},
],
};
License
See LICENSE
Change log
See CHANGELOG