GithubEmoji

by akatopo ST3

Github emoji in markdown documents and commit messages for Sublime Text

Details

Version 2.0.0
Homepage github.com
Issues github.com
Modified 4 years ago
Last Seen 2 days ago
First Seen 10 years ago

Installs

Total 4K
Win 2K
Mac 1K
Linux 999

	Mar 31	Mar 30	Mar 29	Mar 28	Mar 27	Mar 26	Mar 25	Mar 24	Mar 23	Mar 22	Mar 21	Mar 20	Mar 19	Mar 18	Mar 17	Mar 16	Mar 15	Mar 14	Mar 13	Mar 12	Mar 11	Mar 10	Mar 9	Mar 8	Mar 7	Mar 6	Mar 5	Mar 4	Mar 3	Mar 2	Mar 1	Feb 28	Feb 27	Feb 26	Feb 25	Feb 24	Feb 23	Feb 22	Feb 21	Feb 20	Feb 19	Feb 18	Feb 17	Feb 16	Feb 15
Windows	0	0	0	0	0	0	1	0	0	0	0	1	0	0	0	1	0	0	0	0	0	0	3	0	1	0	0	1	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	3	0
Mac	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	1	0	1	0	0
Linux	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0

Readme

Source: raw.githubusercontent.com

Github :octocat: Emoji :panda_face: for Sublime Text

A Sublime Text 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"
  },
  // ...
],

In Sublime Text 4 you do the same for commit emojis: “js { "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](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: <kbd>CTRL</kbd> + <kbd>SHIFT</kbd> + <kbd>P</kbd> (Windows, Linux) or <kbd>CMD</kbd> + <kbd>SHIFT</kbd> + <kbd>P</kbd> 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/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.

Github​Emoji