🐼 for Sublime Text
Github Emoji A Sublime Text plugin for inserting github emoji in markdown documents. Also supports commit message emoji
Usage
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:
"auto_complete_triggers": [
//...
{
"characters": ":",
"selector": "text.html.markdown"
},
// ...
],
In Sublime Text 4 you do the same for commit emojis:
{ "characters": [":", "@"],
"selector": "text.html.markdown, text.git.commit"},
This way when you type :
(or @
in ST4) 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
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
Installation
Package Control (preferred)
- Install Sublime Package Control
- From inside Sublime Text, open Package Control's Command Pallet: CTRL + SHIFT + P (Windows, Linux) or CMD + SHIFT + P on Mac.
- Type
install package
and hit Return. A list of available packages will be displayed. - 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:
git clone https://github.com/akatopo/GithubEmoji.git ~/Library/Application\ Support/Sublime\ Text/Packages/GithubEmoji
Windows:
git clone https://github.com/akatopo/GithubEmoji.git %APPDATA%\Sublime/ Text/\GithubEmoji
Linux:
git clone https://github.com/akatopo/GithubEmoji.git ~/.Sublime\ Text/Packages/GithubEmoji
Credits
Special thanks to @eugenesvk for adding sublime text 4 support.
The list of github emoji (emoji.json) is taken from gemoji.
Installation instructions ripped from MarkdownEditing's readme.
Similar Plugins
The Emoji plugin allows you to insert emoji characters from the command palette.