Emoji List

A Comprehensive List of GitHub emoji markup.

Project Structure

EMOJI-LIST
├── dist
│   ├── emoji-list.md         · Emojis List Markdown (for GitHub Gist)
│   └── missing-emojis.json   · Results from comparing emojis.json to another source
│
├── tasks/                    · Grunt tasks which run the NPM Scripts
│   ├── helpers/              · Supporting files for Grunt tasks
│   ├── alphabetize.js        · npm run alphabetize
│   ├── build.js              · npm run build
│   ├── check-api.js          · npm run check-api
│   ├── compare.js            · npm run compare
│   └── validate.js           · npm run validate
│
├── categories.json           · An array of category objects for sorting emojis
├── compare-emojis.json       · An array of emoji names to compare against emojis.json
├── emojis.json               · An array of emoji objects
│
└── gruntfile.js              · Grunt tasks for Emoji List

NPM Scripts

alphabetize
Alphabetize and Format emojis.json document
Run this after making changes to emojis.json.

build
Generate Emoji List Markdown File
Builds emojis.json into emoji-list.md. Emojis are sorted by category, then by unicode value, then by name.

check-api
Compare against GitHub’s Emojis API.
Results of the comparison are outputted to missing-emojis.json.

compare
Compare against compare-emojis.json
Populate compare-emojis.json with an array of emoji names and run compare to compare this list against emojis.json

validate
Check emojis.json for Errors

Adding an Emoji

Emojis can be added to emojis.json. Each emoji is represented by an object as such:

  {
    "alias": "handshake",
    "unicode": "🤝",
    "category": "Gesture"
  },

alias accepts a string value or array of string values, representing names that can be used to create the emoji.

unicode is the raw emoji character. This is used for sorting the emojis.

category represents a grouping to assign to the emoji. Presently, available groupings can be found in categories.json.

Once you've added emojis, run npm run alphabetize to sort the emojis.json file and npm run build to generate the new emoji-list. If it builds without errors, create a PR.

Thank You!

This project was adapted from rxavier’s Complete list of github markdown emoji markup and categorization was inspired from JoyPixels 5

Other Emoji Lists:

• GitHub Emojis API (OFFICIAL, GitHub Emojis API)
• Awes0mem4n List (GitHub Emojis API)
• Code-Notes Cheatsheet
• Dellos7 List (copy/paste, GitHub Emojis API)
• Ikatyang Cheatsheet (GitHub Emojis API, automatic-updates)
• RXavier List
• WebFX’s Cheatsheet (copy/paste)
• Jzeferino List (copy/paste, GitHub Emojis API, automatic-updates)