A JSON file of GitHub's emojicodes and emoji. Unlike other projects, this one includes the actual emoji and does not alter GitHub's list. Also included is a JSON file formatted for use with the Auto Text Expander extension for Google Chrome, with text to be expanded based based on GitHub's ":EMOJICODE:".
In your project, simply use github_emoji.json. The keys are
GitHub's emojicodes and the values are emoji. For example,
confounded gives ๐.
Note 1: By following the instructions below, all of the existing shortcuts currently defined in your copy of Auto Text Expander will be removed and replaced with the shortcuts contained in this project's JSON file. If you want to keep your existing shortcuts, you should take steps to back them up before proceeding.
Note 2: At the time of writing, Auto Text Expander only supports
510 shortcuts and Chrome limits it to a specific number of total
bytes. The github_emoji_for_autoTextExpander.json file currently
contains 1285 emoji, too many to be used at once. Therefore, you
will need to select the ones that are important to you.
- Click the "Raw" button of the
github_emoji_for_autoTextExpander.jsonfile below. - Select the text you want shown in your browser and copy it to the clipboard.
- In Auto Text Expander, click the "Import / Export" button.
- In the "Import / Export Shortcuts" dialog, select all the text in the textarea and paste the contents of the clipboard.
- Click the "Save" button.
- In the Auto Text Expander "Demo Element", test some of the
emojicodes to be sure they work. For example,
:upside_down_face:should produce ๐.
- When entering text into GitHub fields that support GitHub Flavored
Markdown,
entering a colon makes the emojicode completion suggestions appear.
This is described in the GitHub blog post, "Emoji
autocomplete".
These seem to come from URLs like
"
https://gist.github.com/gist_username/gist_number/suggestions". That returns a HTML document containing GitHub emojicodes and links to PNG images of their representation. Unfortunately, it doesn't include the emoji characters themselves. However, entering a GH comment containing all of those codes and their names let me create thegithub_emoji.jsonfile shown here. This file contains only emoji characters, not the unofficial GH additions, like the "ship it squirrel" (:shipit:=
). - This project began with the
emojis.jsonfile from muan/emojilib. However, I realized that emojilib doesn't use GitHub's emojicodes for all the characters. It includes information for some unofficial emoji supported by GitHub, though, which is why I thought it used GH's emojicodes throughout the list. - Another project, omnidan/node-emoji looked promising, but it
contains additional shortcuts and characters that GH emojicode
doesn't support. (E.g.,
showman= โ) - Tracing through some of the code for GitHub itself shows it uses the Ruby gem "gemoji" to convert emojicodes to emoji. Within that project, the data is specifically contained in the file https://github.com/github/gemoji/raw/master/db/emoji.json.
- Either of the words "emoji" or "emojis" may be used as the plural of "emoji".