# Github :octocat: Emoji :panda_face: for Sublime Text 3 A Sublime Text 3 plugin for inserting github emoji in markdown documents. Also supports [commit message emoji](https://github.com/dannyfritz/commit-message-emoji) ## Usage emoji completion When editing a markdown document type `:` and then press TAB to display the auto-complete popup for github emoji. You can type `@` instead of `:` for commit message emoji. Alternatively, for non-commit emoji, you can add this to your `auto_complete_triggers` in the user preferences: ```js "auto_complete_triggers": [ //... { "characters": ":", "selector": "text.html.markdown" }, // ... ], ``` This way when you type `:` in markdown documents you'll get the autocompletion popup. You can customize the available emoji, scopes, and filenames by copying and editing the default settings (`Preferences > Package Settings > GithubEmoji > Settings – Default`) and saving them into your own user settings (`Preferences > Package Settings > GithubEmoji > Settings – User`) You can check available github emoji at the [emoji cheat sheet](http://www.emoji-cheat-sheet.com/) **Note:** On linux you will need a font that includes emoji in order to see emoji characters in the auto-complete popup. Here's [one](https://github.com/MorbZ/OpenSansEmoji) ## Installation ### Package Control (preferred) 1. [Install Sublime Package Control](http://wbond.net/sublime_packages/package_control/installation) 2. From inside Sublime Text, open Package Control's Command Pallet: CTRL + SHIFT + P (Windows, Linux) or CMD + SHIFT + P on Mac. 3. Type `install package` and hit Return. A list of available packages will be displayed. 4. Type `GithubEmoji` and hit Return. The package will be downloaded to the appropriate directory. ### Manual Installation Download or clone this repository to a directory `GithubEmoji` in the Sublime Text Packages directory for your platform: **Mac:** ```shell git clone https://github.com/akatopo/GithubEmoji.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/GithubEmoji ``` **Windows:** ```shell git clone https://github.com/akatopo/GithubEmoji.git %APPDATA%\Sublime/ Text/ 3/\GithubEmoji ``` **Linux:** ```shell git clone https://github.com/akatopo/GithubEmoji.git ~/.Sublime\ Text\ 3/Packages/GithubEmoji ``` ## Known Issues * Emoji characters in the auto-complete popup appear broken for windows 7 and 8. * Emoji character colors in OS X (tested on El Capitan) look ...inverted? Please drop me a line for any other OS specific strangeness or workarounds. ## Credits The list of github emoji ([emoji.json](https://github.com/github/gemoji/blob/3f6057146c9a12e154c7bf00be4b125a76f413e0/db/emoji.json)) is taken from [gemoji](https://github.com/github/gemoji). Installation instructions ripped from [MarkdownEditing](https://github.com/SublimeText-Markdown/MarkdownEditing)'s readme. ## Similar Plugins The [Emoji](https://github.com/ethanal/SublimeEmoji/) plugin allows you to insert emoji characters from the command palette.