Article version:

Emoji on GitHub Pages

You can use emoji within any Jekyll page or post, just like you would in a comment or issue within a repository on GitHub.

GitHub Pages is available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."

Setting up

To enable emoji, you must add the following line to your site's _config.yml file:

  - jemoji

If you don't have a _config.yml file, you will need to create one in the root of your GitHub Pages repository. For more information, see Jekyll's official plugins documentation.


Use emoji within your Jekyll posts or pages as you would elsewhere on GitHub.

Testing locally

To preview the output of emoji locally:

Note: Emoji are currently only supported in the page and post body. Emoji within includes, layouts, and other sources of content may not render properly.

For more information, see The Jemoji Gem.

Ask a human

Can't find what you're looking for?

Contact us