OpenMoji Jekyll Plugin
Beautiful OpenMoji emojis on your Jekyll websites.
OpenMoji is a free and open source emoji library which can be used for variety of purposes.
This project is a fork of Jemoji. It's also independent from OpenMoji project.
Enjoy a free open source emoji package
Use more than 3,000 emoji from OpenMoji package for free in your jekyll website.
Connect to any other emoji source
Use any available emoji package from a CDN or locally served emoji images by adding only 3 lines to your website's config file.
Quick start
1. Add the following to your site's Gemfile
gem 'jekyll-openmoji'
2. Add the following to your site's _config.yml
plugins:
- jekyll-openmoji
3. Next steps
In any page or post, use emoji as you would normally, e.g.
I give this plugin two :+1:!
Customizing
If you'd like to serve emoji images locally, or use a custom emoji source,
you can specify so in your _config.yml file:
emoji:
# src key is required .
# images will be served from this base address
# it must be a valid URL, if you don't provide a string to src key
# plugin will ignore this settings and uses default settings.
src: "https://www.emojisource.com"
# asset key is optional.
# it will be appended to the end of src keyword to make a complete URL,
# if you don't provide the asset value, it will be defaulted to "emoji".
asset: "/color/svg"
# final path will be "https://www.emojisource.com/color/svg" and
# emoji images will serve from this address.
# in case of no asset value, final path would be "https://www.emojisource.com/color/svg"emoji
How it works
For all sites emoji images are served from the GitHub.com CDN, with a
base URL of https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest and
asset path of /images/color/svg, which results in emoji image URLs like
https://cdn.jsdelivr.net/gh/azadeh-afzar/OpenMoji-Jekyll-Plugin@latest/images/color/svg/1f604.svg.
However you can alter the default path in _config.yml to serve from external sources.
Notes
Emoji files names should be unicode strings, for example name of this emoji 😄 image file must be: 1f604
Contribution
If you want to contribute to this project, please read CONTRIBUTING.
Code of Conduct
Visit the Code of Conduct.
Roadmap
Visit the Roadmap to keep track of which features we are currently working on.
License
Licensed under the GPL v3.