Emoji on GitHub Pages
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.
You can use emoji within any Jekyll page or post, just like you would in a comment or issue within a repository on GitHub Enterprise.
Setting up
To enable emoji, you must add the following line to your site's _config.yml file:
plugins:
- jemojiIf 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.
Usage
Use emoji within your Jekyll posts or pages as you would elsewhere on your GitHub Enterprise Server instance.
Testing locally
To preview the output of emoji locally:
- Add
jemojito your site's _config.yml file - Make sure you're using the latest version of the GitHub Pages Gem, which contains these dependencies and plugins.
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.