JuanitoFatas / jekyll-twemoji

Twemoji plugin for Jekyll.

Jekyll::Twemoji

Twemoji plugin for Jekyll in Pure Ruby. Powered by Twemoji.

Note this Gem does not work on GitHub Pages. You need to make a feature request to GitHub to convince them include this gem by default on GitHub Pages.

Installation

Add this in your jekyll-powered site's Gemfile:

gem "jekyll-twemoji"

And then execute:

$ bundle

Then add this to your site's _config.yml:

gems:
  - jekyll/twemoji

Use Twemoji like you aways do:

I give this plugin :thumbsup:!

Note that in Twemoji, a 👍 is called :thumbsup:, not :+1:.

Configuration

Image Type

Defaults to svg. To change to png, you need to supply image_type and image_size both:

jekyll-twemoji:
  image_type: "png" # defaults to "svg"
  image_size: "32x32" # defaults to "16x16"

• image_type can be: "png" or "svg" (default).
• image_size can be: "16x16" (default), "32x32" or "72x72".

That's it. 😉

Attribution Requirements

Please follow the Attribution Requirements as stated on the official Twemoji project.

Contributing

1. Fork it ( https://github.com/JuanitoFatas/jekyll-twemoji/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

License

MIT License. See LICENSE for details.