Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bloggify/showdown-emoji

:yum: A Showdown extension for replacing emoji codes with images.
https://github.com/bloggify/showdown-emoji

bloggify emoji hacktoberfest markdown showdown showdown-extension

Last synced: about 2 months ago
JSON representation

:yum: A Showdown extension for replacing emoji codes with images.

Awesome Lists containing this project

README

        

# showdown-emoji

[![Version](https://img.shields.io/npm/v/showdown-emoji.svg)](https://www.npmjs.com/package/showdown-emoji) [![Downloads](https://img.shields.io/npm/dt/showdown-emoji.svg)](https://www.npmjs.com/package/showdown-emoji)

> A Showdown extension for replacing emoji codes with images.

This package uses [GitHub Emoji APIs](https://developer.github.com/v3/emojis/) to display the emojis in [Showdown](https://github.com/showdownjs/showdown) HTML outputs. :tada:

## :cloud: Installation

```sh
# Using npm
npm install --save showdown-emoji

# Using yarn
yarn add showdown-emoji
```

## :clipboard: Example

```js
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);
//

Hello World! :heart:
```

## :question: Get Help

There are few ways to get help:

1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). 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. :bug:

## :memo: 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. (default: `"/emojis"`)

#### Return
- **Array** The configuration used by Showdown.

## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].

## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

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

## :scroll: License

[MIT][license] © [Bloggify][website]

[license]: /LICENSE
[website]: https://bloggify.org
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md