# remarkable-emoji

> Plugin to add emoji support to https://github.com/jonschlinkert/remarkable

Latest version **0.1.3** (published 2014-11-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install remarkable-emoji
pnpm add remarkable-emoji
yarn add remarkable-emoji
bun add remarkable-emoji
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2014-11-27 |
| First published | 2014-11-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Askabt |
| Maintainers | askabt |
| Keywords | remarkable-plugin, remarkable, emoji, emoticons |

## Links

- npm: https://www.npmjs.com/package/remarkable-emoji
- Repository: https://github.com/scrollback/remarkable-emoji
- Homepage: http://scrollback.io
- Issues: https://github.com/scrollback/remarkable-emoji/issues
- npm.io page: https://npm.io/package/remarkable-emoji

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [stockfish](https://npm.io/package/stockfish.md) — 27.0K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads

## Recent versions

- 0.1.3 (latest) — 2014-11-27
- 0.1.2 — 2014-11-27
- 0.1.1 — 2014-11-27
- 0.1.0 — 2014-11-27

## README

# remarkable-emoji

A plugin to add emoji support for [Remarkable](https://github.com/jonschlinkert/remarkable).
The plugin can translate all emojis and most common emoticons to their unicode characters. It can be used in combination with 
client-side libraries such as Twitter's [Twemoji](https://github.com/twitter/twemoji) to generate cross platform image based emojis.

## Installation

This plugin can be installed via npm.

```bash
    npm install remarkable-emoji
```

## Usage

```javascript
    var Remarkable = require('remarkable');
    var remarkable-emoji = require('remarkable-emoji');
    var md = new Remarkable();
    
    md.use(remarkable-emoji);
    
    md.render("# I :laughing: when I am :)");
```

This plugin can be used in combination with Twemoji as such:

```javascript
    var renderedText = twemoji.parse(md.render("This is an airplane :airplane:"));
    console.log(renderedText);
```

---
_Source: https://npm.io/package/remarkable-emoji · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
