Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jekyll/jemoji
GitHub-flavored emoji plugin for Jekyll
https://github.com/jekyll/jemoji
Last synced: 11 days ago
JSON representation
GitHub-flavored emoji plugin for Jekyll
- Host: GitHub
- URL: https://github.com/jekyll/jemoji
- Owner: jekyll
- License: mit
- Created: 2014-01-05T19:47:40.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-12-25T02:38:34.000Z (6 months ago)
- Last Synced: 2024-06-04T19:35:59.660Z (16 days ago)
- Language: Ruby
- Homepage: http://rubygems.org/gems/jemoji
- Size: 23.6 MB
- Stars: 551
- Watchers: 11
- Forks: 62
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: History.markdown
- License: LICENSE
Lists
- awesome-jekyll-plugins - **Jemoji** - - GitHub-flavored emoji plugin **#Official** **#GitHub Pages** (Text Filters)
- my-awesome-stars - jekyll/jemoji - GitHub-flavored emoji plugin for Jekyll (Ruby)
- awesome_jekyll_plugins - **Jemoji** - - GitHub-flavored emoji plugin **#Official** **#GitHub Pages** (Text Filters)
- awesome-lists-awesome-jekyll-plugins - **Jemoji** - - GitHub-flavored emoji plugin **#Official** **#GitHub Pages** (Text Filters)
- stars - jekyll/jemoji - flavored emoji plugin for Jekyll (HarmonyOS / Windows Manager)
- awesome-stars - jekyll/jemoji - GitHub-flavored emoji plugin for Jekyll (Ruby)
README
# Jemoji
GitHub-flavored Emoji plugin for Jekyll
[](http://badge.fury.io/rb/jemoji)
[](https://travis-ci.org/jekyll/jemoji)
## Usage
Add the following to your site's `Gemfile`
```
gem 'jemoji'
```
And add the following to your site's `_config.yml`
```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.
```markdown
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:
```yml
emoji:
src: "/assets/images/emoji"
```
See the [Gemoji](https://github.com/github/gemoji) documentation for generating image files.