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 2K
  • Win 700
  • OS X 547
  • Linux 379
Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22 Dec 21 Dec 20 Dec 19 Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10
Windows 0 1 2 1 1 0 0 0 0 0 0 1 0 0 1 0 0 0 1 1 0 1 0 0 0 0 0 3 0 1 1 2 4 2 0 2 2 1 0 1 1 0 0 0 0
OS X 0 0 0 1 1 1 2 0 1 1 0 0 1 0 1 1 1 1 1 2 0 0 0 0 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 2 0
Linux 0 0 0 0 1 0 1 0 0 1 1 1 0 0 1 1 0 0 0 1 0 0 1 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 1 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.