https://github.com/4ch1m/github-markdown-emojis

A plugin for the IntelliJ platform to instantly preview Emojis of GitHub-flavoured markdown.
https://github.com/4ch1m/github-markdown-emojis

emojis github idea intellij markdown plugin

Last synced: 7 months ago
JSON representation

A plugin for the IntelliJ platform to instantly preview Emojis of GitHub-flavoured markdown.

• Host: GitHub
• URL: https://github.com/4ch1m/github-markdown-emojis
• Owner: 4ch1m
• License: mit
• Created: 2022-12-11T15:46:47.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2025-02-16T16:48:37.000Z (8 months ago)
• Last Synced: 2025-02-16T17:39:38.879Z (8 months ago)
• Topics: emojis, github, idea, intellij, markdown, plugin
• Language: Kotlin
• Homepage:
• Size: 536 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ![Octomoji](src/main/resources/META-INF/pluginIcon.png) GitHub Markdown Emojis

> A plugin for the IntelliJ platform to instantly preview Emojis of GitHub-flavoured markdown.

## Table of Contents

* [Screenshot](#camera-screenshot)

* [HowTo](#book-howto)

  * [Install](#gear-install)

  * [Use](#partying_face-use)

  * [Build](#hammer-build)

* [License](#balance_scale-license)

* [References](#link-references)

* [Credits](#star-credits)

* [Disclaimer](#point_up-disclaimer)

* [Donate](#heart-donate)

## :camera: Screenshot

![screenshot](screenshot.png)

## :book: HowTo

### :gear: Install

Use the IDE's built-in plugin system:

* `File` --> `Settings...` --> `Plugins` --> `Marketplace`

* search for: `GitHub Markdown Emojis`

* click the `Install`-button

Or go to the [plugin page](https://plugins.jetbrains.com/plugin/20705) on the [JetBrains](https://www.jetbrains.com)-website, download the archive-file and install manually.

### :partying_face: Use

There's nothing more to set up.  

Simply use the GitHub-Emojis (e.g. `:smile:`) in your markdown file and active the preview window/pane.  

You should see the rendered images instead of just plain text.

NEW :heavy_check_mark: ...  

The toolbar window will show you all available Emojis. Clicking on an Emoji will put the shortcode into the clipboard.

### :hammer: Build

* clone the repo:  

`git clone https://github.com/4ch1m/github-markdown-emojis.git`

* change directory:  

`cd github-markdown-emojis`

* use the [Gradle](https://gradle.org)-wrapper to build the plugin:  

`./gradlew buildPlugin`

* a deployable ZIP file can then be found here:  

`./build/distributions/GitHub Markdown Emojis-*.zip`

## :balance_scale: License

Please read the [license](LICENSE) file.

## :link: References

* [Github Emoji API](https://api.github.com/emojis)

* [Emoji Cheat Sheet](https://github.com/ikatyang/emoji-cheat-sheet)

## :star: Credits

* _Smiley_ - Microsoft's [Fluent Emoji](https://github.com/microsoft/fluentui-emoji) collection

* _Octocat_ - based on [johan](https://gist.github.com/johan/1007813)'s SVG

* _Heart_ icon - courtesy of [FontAwesome](https://fontawesome.com/icons/heart?s=solid&f=classic)

## :point_up: Disclaimer

This project is not affiliated with or endorsed by [GitHub](https://github.com).

## :heart: Donate

If you like this plugin, please consider a [donation](https://paypal.me/AchimSeufert). Thank you!