docute-emojify

docute-emojify

Docute plugin for transforming emoji aliases within Markdown.

Installation

Get the UMD build and place it before config.js inside your index.html file:

<script src="https://unpkg.com/docute-emojify"></script>

Then, configure the plugin within config.js.

self.$config = {
  plugins: [
    docuteEmojify(),
  ],
};

This plugin requires Docute >=2.9.

Usage

Emoji aliases will be replaced with their respective Unicode characters within your Markdown documents. For instance,

This is **Markdown** with :100: emoji support :ok_hand:

will render as

This is Markdown with 💯 emoji support 👌

All emoji aliases are scraped from the gemoji repository.

Adding Aliases

You can add additional aliases for existing emoji by providing an aliases object when you configure the plugin.

docuteEmojify({
  aliases: {
    100: 'hundo',
    thinking: [
      'thunking',
      'thonk',
    ],
  },
});

This will replace :hundo: with 💯 and :thunking: or :thonk: with 🤔.

Blacklisting Aliases

Aliases may be blacklisted by providing an array of aliases as the blacklist option.

docuteEmojify({
  blacklist: [
    '100',
    '+1',
  ],
});

This will make :100: and :+1: render as typed rather than as an emoji character.

Changelog

[0.1.2] - 2017-03-11

Fixed

• Messed up package meta.