Skip to content
This repository has been archived by the owner on Apr 24, 2019. It is now read-only.
/ metalsmith-emoji Public archive

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

License

Notifications You must be signed in to change notification settings

tech4him1/metalsmith-emoji

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

metalsmith-emoji

GitHub issues license node Greenkeeper badge Build Status

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
}));

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •