Skip to content
Get packs

Guide · Open source

How to use emoji-cheat-sheet: find and copy markdown emoji shortcodes

Updated · written with AI from the project's own documentation and checked against our catalogue data

emoji-cheat-sheet by ikatyang is a markdown reference page that lists emoji by category and shows the shortcode you type to insert each one. This guide is for developers writing README files or GitHub comments, and for anyone who wants to look up a shortcode without searching elsewhere. After reading it, you will know how to find a shortcode in the sheet, how to read its layout, and how to get a local copy of the repository.

emoji-cheat-sheetikatyang/emoji-cheat-sheet · ★ 13.8k · MIT

Quick start

  1. 1Open the cheat sheet. Go to the emoji-cheat-sheet page on GitHub or clone the repository locally with git.
  2. 2Pick a category. Use the table of contents to choose a category such as Smileys & Emotion or Animals & Nature.
  3. 3Find your emoji. Scan the tables or use your browser's find feature to locate the emoji you want.
  4. 4Copy the shortcode. Copy the text in backticks, including both colons, exactly as shown.
  5. 5Paste into markdown. Paste the shortcode into your README or GitHub comment and preview to confirm it renders.

What the emoji-cheat-sheet is

emoji-cheat-sheet is a static reference document rather than a program. Each table pairs an emoji with its shortcode, such as :smile: for a smiling face, written inside backticks so you can see the exact text.

The README says the sheet is generated automatically from the GitHub Emoji API and the Unicode Full Emoji List, so the shortcodes come from those sources.

  • Emoji are grouped into categories such as Smileys & Emotion, People & Body, Animals & Nature, Food & Drink, Travel & Places, Activities, Objects, Symbols, Flags and GitHub Custom Emoji.
  • Each category has a table of contents and subsections, for example Face Smiling and Face Affection under Smileys & Emotion.
  • Some emoji have more than one shortcode, for example :laughing: and :satisfied: are listed together.

Find an emoji shortcode in the sheet

Open the sheet and use the table of contents to jump to the category that fits your emoji. Within a subsection, each row shows the emoji image on one side and its shortcode in backticks next to it.

Copy the shortcode exactly, including both colons, and paste it where you are writing markdown. The shortcode is the text you type, not the picture.

  • Start with the category list at the top of the page if you do not know the exact name.
  • Use your browser's find feature to search for a word such as smile or cat if you know part of the name.
  • Check the backticked text, since that is the literal shortcode.
:smile:

Get a local copy of the repository

The README gives one install command: cloning the repository with git. Run it in a terminal to download the files to your computer so you can read the sheet offline.

The repository is licensed under MIT and written in TypeScript. The README does not list any prerequisites, so the only tool it names is git.

git clone https://github.com/ikatyang/emoji-cheat-sheet

Use shortcodes in a GitHub README or comment

Shortcodes are written between two colons. When you paste one into a markdown file or a GitHub comment, the platform displays the matching emoji. The sheet is aimed at this use.

Shortcodes may not render in plain-text messages outside markdown, so check the destination before relying on them.

  • Paste the shortcode into the text where the emoji should appear.
  • Preview the file or comment to confirm the emoji displays.
  • If the emoji does not show, check the spelling against the sheet, since the shortcode must match exactly.
Thanks for the help! :thumbsup:

What people use it for

  • Finding the exact shortcode for a status emoji in a project README.
  • Browsing the Animals & Nature or Food & Drink categories to pick an emoji for a pull request comment.
  • Keeping a local copy of the sheet with git clone for quick reference without an internet connection.
  • Checking which alternative shortcodes exist for one emoji, such as :laughing: and :satisfied:.

Frequently asked questions

How do I install emoji-cheat-sheet?

The README gives one command: git clone https://github.com/ikatyang/emoji-cheat-sheet. Run it in a terminal to download the repository. There is no separate installation step described in the README.

Is emoji-cheat-sheet free to use?

The project is licensed under MIT, as listed on its page. Check the LICENSE file in the repository for the full terms.

What programming language is emoji-cheat-sheet written in?

The project is written in TypeScript, according to its listing. The sheet itself is a reference document, so you do not need to run code to read it.

Can emoji-cheat-sheet insert emoji into my text automatically?

No. The README describes a static reference sheet, not a tool or API. It shows you the shortcode, and you paste it into your markdown yourself.

Why does my emoji shortcode not show up?

Shortcodes are meant for markdown, such as GitHub READMEs and comments. Plain-text messages outside markdown may not render them. Also confirm the spelling matches the sheet exactly, including both colons.

What are alternatives to emoji-cheat-sheet?

Comparable projects include gemoji, emojilib and node-emoji. The sheet is a browsable document, while these are typically libraries, so pick based on whether you need reading or code.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Use emoji-cheat-sheet if you write markdown on GitHub and need to look up a shortcode quickly or browse emoji by category. Pick a library such as gemoji, emojilib or node-emoji if you need a program to insert emoji automatically, or if your text will not be rendered as markdown.

Install options & downloads