Skip to content

jekyll/jemoji

Folders and files

NameName
Last commit message
Last commit date

Latest commit

1b3e31f · Sep 5, 2023
Sep 5, 2023
Nov 19, 2022
Dec 3, 2017
Aug 16, 2020
Mar 5, 2020
Sep 21, 2017
Nov 16, 2022
Dec 24, 2020
Nov 16, 2022
Sep 5, 2023
Jan 3, 2018
Feb 13, 2019
Dec 3, 2017
Nov 16, 2022

Repository files navigation

Jemoji

GitHub-flavored Emoji plugin for Jekyll

Gem Version Build Status

Usage

Add the following to your site's Gemfile

gem 'jemoji'

And add the following to your site's _config.yml

plugins:
  - jemoji

💡 If you are using a Jekyll version less than 3.5.0, use the gems key instead of plugins.

In any page or post, use emoji as you would normally, e.g.

I give this plugin two :+1:!

Emoji images

For GitHub Pages sites built on GitHub.com, emoji images are served from the GitHub.com CDN, with a base URL of https://github.githubassets.com, which results in emoji image URLs like https://github.githubassets.com/images/icons/emoji/unicode/1f604.png.

On GitHub Enterprise installs, page builds receive the ASSET_HOST_URL environment variable, which contain a value like https://assets.ghe.my-company.com. This results in emoji images for GitHub Pages sites built on a GitHub Enterprise install being served at URLs like https://assets.ghe.my-company.com/images/icons/emoji/unicode/1f604.png.

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: "/assets/images/emoji"

See the Gemoji documentation for generating image files.