hexo-filter-emoji

A Hexo plugin that adds emoji support, using Github Emojis API.

Check out the Emoji Cheat Sheet for all the emojis it supports.

Installation

1$ npm install hexo-filter-emoji
2$ hexo clean

Options

You can configure this plugin in Hexo _config.yml. Default options:

1emoji:
2  enable: true
3  className: github-emoji
4  styles:
5  customEmojis:

• className - Image class name. For example :sparkles: :sparkles: the filter will generate something like this:

  1<span class="github-emoji" style="background-image: url(https://assets-cdn.github.com/images/icons/emoji/unicode/2728.png?v8)" data-src="https://assets-cdn.github.com/images/icons/emoji/unicode/2728.png?v8">&#x2728;</span>

• styles - inline styles. For example:

  1emoji:
  2  styles:
  3    font-size: 2em
  4    font-weight: bold

  outputs:

  1<span class="github-emoji" style="font-size: 2em; font-weight: bold; background-image: url(...)" ...>

• customEmojis - You can specify your own list. An object or JSON string is valid. The filter will first check the customEmojis then fallback to the [Github Emojis][ghemojis] list.

  For example:

  1emoji:
  2  customEmojis:
  3    arrow_left: https://path/to/arrow_left.png
  4    arrow_right: https://path/to/arrow_right.png

  If you need to add code points that are not in the Github list, you can do this:

  1emoji:
  2  customEmojis:
  3    man_juggling:
  4      src: https://path/to/man_juggling.png
  5      codepoints: ["1f939", "2642"]
  6    arrow_right: https://path/to/arrow_right.png

Tag

If you do not like the ::-style keywords, you can always use tags:

1{% emoji sparkles %}

Add no-emoji: true to front-matter to stop replacing :::

1---
2title: Hello World
3no-emoji: true
4---
5
6:tada: as it is.
7
8{% emoji tada %} still works.

Helper

You can also render a GitHub emoji from a template using the emoji helper:

1<h1>{% emoji('octocat') %}</h1>