Socket
Socket
Sign inDemoInstall

remark-emoji

Package Overview
Dependencies
5
Maintainers
1
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    remark-emoji

Emoji transformer plugin for Remark


Version published
Weekly downloads
383K
decreased by-14.8%
Maintainers
1
Created
Weekly downloads
 

Package description

What is remark-emoji?

The remark-emoji npm package is a plugin for the remark processor that allows you to convert text-based emoji shortcodes into their corresponding Unicode emoji characters. This can be particularly useful for rendering markdown content with emojis in a more visually appealing way.

What are remark-emoji's main functionalities?

Convert Emoji Shortcodes to Unicode

This feature allows you to convert text-based emoji shortcodes (e.g., :heart:) into their corresponding Unicode emoji characters (❤️). The code sample demonstrates how to use the remark-emoji plugin with the remark processor to achieve this conversion.

const remark = require('remark');
const emoji = require('remark-emoji');

const markdown = 'I :heart: remark-emoji!';

remark()
  .use(emoji)
  .process(markdown, function (err, file) {
    if (err) throw err;
    console.log(String(file));
  });

Other packages similar to remark-emoji

Readme

Source

remark-emoji

Build Status

This is a remark plugin to replace :emoji: to real UTF-8 emojis in text.

Usage

remark().use(emoji [, options]);
const remark = require('remark');
const emoji = require('remark-emoji');

const doc = 'Emojis in this text will be replaced: :dog: :+1:';
console.log(remark().use(emoji).process(doc).contents);
// => Emojis in this text will be replaced: 🐶 👍

Options

options.padSpaceAfter

Setting to true means that an extra whitespace is added after emoji. This is useful when browser handle emojis with half character length and following character is hidden. Default value is false.

License

Distributed under the MIT License.

Keywords

FAQs

Last updated on 18 Nov 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc