Way 1: type the emoji
Markdown is plain text, and emoji are just characters, so an emoji typed into the file shows in any app that can show emoji. This is the portable way.
To open the emoji picker:
| System | Keys |
|---|---|
| Windows | Win + . |
| macOS | Ctrl + Cmd + Space |
| Linux | Depends on the desktop and the app |
| Phones | The emoji key on the keyboard |
Way 2: shortcodes
A shortcode is a name between colons. GitHub, Slack, Discord and many other apps turn it into the emoji with that name while you type or when they show the text.
You write
:smile: :heart: :thumbsup: :warning:You see
:smile: :heart: :thumbsup: :warning:
Where shortcodes work:
| App | Shortcodes |
|---|---|
| GitHub | Yes, in files, issues and comments |
| Slack, Discord | Yes, in their own messages |
| MarkdownPaper | No, they stay as text |
| Many other apps | Often no |
Because support varies, a shortcode that shows as an emoji on GitHub can show
as :smile: everywhere else. If the file will be read in more than one place,
type the emoji itself.
Finding a shortcode
GitHub's list of supported shortcodes is in its documentation, and many editors suggest them as you type a colon and the first letters of a name.
Should you use emoji in documents?
Use them sparingly. Screen readers read each emoji's name aloud, so a line full of them is slow to listen to. One emoji at the start of a status line, like a tick for done, reads well. A row of them in a heading does not.
Questions
How do I add emoji to a GitHub README?
Type the emoji directly, or use a shortcode like :sparkles:. Both work on
GitHub.
Why do my emoji shortcodes show as text?
The app does not support shortcodes. Type the emoji itself with your system's emoji picker instead.
Do emoji work in headings and tables?
Yes. Emoji are characters like any other, so they work anywhere text does.
Next
- Markdown text formatting, for other ways to make text stand out.
- Open your Markdown in the reader to see how it reads.