ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Github​Emoji

by akatopo ST3

Github emoji in markdown documents and commit messages for Sublime Text 3

Labels emoji, github, markdown

Details

Installs

  • Total 3K
  • Win 1K
  • OS X 798
  • Linux 634
Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28 Oct 27 Oct 26 Oct 25 Oct 24 Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30
Windows 1 1 0 2 1 0 1 1 0 4 0 0 1 0 0 0 1 0 0 0 1 0 0 3 2 1 1 1 2 0 0 0 0 0 2 1 0 1 1 0 0 0 2 1 1 2
OS X 0 1 0 0 0 1 0 0 0 0 2 2 0 1 0 0 0 0 1 0 0 0 0 0 0 1 0 0 1 0 0 0 1 0 1 1 2 0 0 0 0 1 0 0 0 0
Linux 0 1 0 0 0 0 2 0 5 1 0 0 0 0 0 0 0 0 0 0 0 1 0 0 1 0 0 0 1 0 2 0 0 0 0 0 0 0 0 1 0 0 0 1 0 0

Readme

Source
raw.​githubusercontent.​com

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

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:

"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

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)

  1. Install Sublime Package Control
  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:

git clone https://github.com/akatopo/GithubEmoji.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/GithubEmoji

Windows:

git clone https://github.com/akatopo/GithubEmoji.git %APPDATA%\Sublime/ Text/ 3/\GithubEmoji

Linux:

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) 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.