README.md

metalsmith-emoji

A Metalsmith plugin to process emoji and convert emoji shortnames, using the EmojiOne list.

Installation

$ npm install metalsmith-emoji

Usage

This plugin will only process emoji in markdown and HTML files by default. This can be changed through the pattern option below, which takes an array of minimatch patterns.

If you want the emoji to be images (PNG) instead of Unicode characters, set convertToImages to true.

Deprecated: If you don't want the plugin to convert shortnames (like :smile:) to actual emoji, set processShortnames to false.

Default Options

{
    pattern: ["**/*.md", "**/*.markdown", "**/*.html", "**/*.htm"],
    convertToImages: false
}

Example

var emoji = require('metalsmith-emoji');

metalsmith.use(emoji({
  pattern: ["**/*.md", "**/*.markdown", "**/*.html", "data/*"],
  convertToImages: true
}));