showdown-emoji

πŸ˜‹ A Showdown extension for replacing emoji codes with images.

Showing:

Popularity

Downloads/wk

1.6K

GitHub Stars

3

Maintenance

Last Commit

5mos ago

Contributors

1

Package

Dependencies

2

Size (min+gzip)

9.7KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

showdown-emoji

Version Downloads

A Showdown extension for replacing emoji codes with images.

This package uses GitHub Emoji APIs to display the emojis in Showdown HTML outputs. πŸŽ‰

☁️ Installation

# Using npm
npm install --save showdown-emoji

# Using yarn
yarn add showdown-emoji

πŸ“‹ Example

const showdown = require('showdown')
    , showdownEmoji = require("showdown-emoji")
    ;

// After requiring the module, use it as extension
let converter = new showdown.Converter({
    extensions: [showdownEmoji]
});

// Now you can Emoji code blocks
let html = converter.makeHtml("Hello World! :heart:");

console.log(html);
// <p>Hello World! <img src="https://github.global.ssl.fastly.net/images/icons/emoji/heart.png?v5" alt=":heart:" title=":heart:" class="emoji-img emoji"</p>

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. πŸ›

πŸ“ Documentation

showdownEmoji(emojiDirPath)

Replace the :emojis: in the text with images.

Params

  • String emojiDirPath: The public path to the emoji directory containing the emoji images.

Return

  • Array The configuration used by Showdown.

πŸ˜‹ How to contribute

Have an idea? Found a bug? See how to contribute.

πŸ’« Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

  • mdpdf
  • bloggify-emoji
  • @penciljs/core
  • docbook

πŸ“œ License

MIT Β© Bloggify

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100