# hexo-filter-github-emojis
[](https://npmjs.org/package/hexo-filter-github-emojis)
[](https://npmjs.org/package/hexo-filter-github-emojis)
[](https://npmjs.org/package/hexo-filter-github-emojis)
[](https://npmjs.org/package/hexo-filter-github-emojis)
A Hexo plugin that adds emoji support, using [Github Emojis API][ghemojis].
Check out the [Emoji Cheat Sheet](http://www.webpagefx.com/tools/emoji-cheat-sheet/) for all the emojis it supports.
## Installation
``` bash
$ npm install hexo-filter-github-emojis --save
```
## Options
You can configure this plugin in `_config.yml`. Default options:
``` yaml
githubEmojis:
enable: true
className: github-emoji
inject: true
styles:
customEmojis:
```
- **enable** `boolean=true` - Enable `::` emoji parsing. If off the [tag](#tag) and [helper](#helper) still work.
- **className** `string="github-emoji"` - Emoji class name.
For example :sparkles: `:sparkles:` the filter will generate something like this:
```html
✨
```
- **inject** `boolean=true` - Inject emoji styles and fallback script.
If `true`, the filter will inject a `
```
- **styles** `object={}` - inline styles. For example:
```yaml
githubEmojis:
styles:
font-size: 2em
font-weight: bold
```
outputs:
```html
```
- **customEmojis** `object={}` - 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:
```yaml
githubEmojis:
customEmojis:
arrow_left: https://path/to/arrow_left.png
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:
```yaml
githubEmojis:
customEmojis:
man_juggling:
src: https://path/to/man_juggling.png
codepoints: ["1f939", "2642"]
arrow_right: https://path/to/arrow_right.png
```
## Tag
If you do not like the `::`-style keywords, you can always use tags:
```html
{% github_emoji sparkles %}
```
Add `no-emoji: true` to front-matter to stop replacing `::`:
```md
---
title: Hello World
no-emoji: true
---
:tada: as it is.
{% github_emoji tada %} still works.
```
## Helper
You can also render a GitHub emoji from a template using the `github_emoji` helper:
```html
<%- github_emoji('octocat') %>
```
[ghemojis]: https://api.github.com/emojis