zhao
/
hexo-filter-github-emojis
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
hexo-filter-github-emojis/README.md

2.1 KiB
Raw Blame History

hexo-filter-github-emojis

Build Status Coverage Status Npm Version Npm Downloads Month Npm Downloads Total License

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

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

Installation

$ npm install hexo-filter-github-emojis --save

Options

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

githubEmojis:
  enable: true
  className: github-emoji
  localEmojis:

The filter will try to download the latest version of Github Emojis list. If the network is unavailable or too slow it will use the backup version.

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

    <img class="github-emoji" title=":sparkles:" alt=":sparkles:" src="https://assets-cdn.github.com/images/icons/emoji/unicode/2728.png" height="20" width="20">

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

    For example:

    githubEmojis:
  localEmojis:
    arrow_left: https://path/tp/arrow_left.png
    arrow_right: https://path/tp/arrow_right.png