Nondeterministic Programming Methodology
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

showdown-emoji

2.0.0 • Public • Published

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.

📜 License

MIT © Bloggify

Install

npm i showdown-emoji

DownloadsWeekly Downloads

885

Version

2.0.0

License

MIT

Unpacked Size

5.39 kB

Total Files

4

Last publish

Collaborators

  • avatar