jonathanlermitage/github-markdown-emojis

(forked to submit https://github.com/4ch1m/github-markdown-emojis/pull/1)

GitHub Markdown Emojis

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

Table of Contents

• Screenshot
• HowTo
  • Install
  • Use
  • Build
• License
• References
• Credits
• Disclaimer
• Donate

📷 Screenshot

📖 HowTo

⚙️ 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 on the JetBrains-website, download the archive-file and install manually.

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

🔨 Build

• clone the repo:
  git clone https://github.com/4ch1m/github-markdown-emojis.git
• change directory:
  cd github-markdown-emojis
• use the Gradle-wrapper to build the plugin:
  ./gradlew buildPlugin
• a deployable ZIP file can then be found here:
  ./build/distributions/GitHub Markdown Emojis.zip

⚖️ License

Please read the license file.

🔗 References

• Github Emoji API
• Emoji Cheat Sheet

⭐ Credits

• Smiley - Microsoft's Fluent Emoji collection
• Octocat - based on johan's SVG
• Heart icon - courtesy of FontAwesome

☝️ Disclaimer

This project is not affiliated with or endorsed by GitHub.

❤️ Donate

If you like this plugin, please consider a donation. Thank you!