Plugins

Emoji

nizel-plugin-emoji replaces known :name: shortcuts with emoji before Markdown is parsed.

Fenced code blocks and inline code spans are preserved.

Install

npm install nizel-plugin-emoji

Usage

import { useNizel } from 'nizel';
import { emojiPlugin } from 'nizel-plugin-emoji';

const nizel = useNizel({
  plugins: [emojiPlugin()],
});

const text = await nizel.text('Ship it :rocket:');

Built-In Shortcuts

Common shortcuts include:

• :smile:
• :heart:
• :thumbsup:
• :fire:
• :rocket:
• :check:
• :warning:
• :tada:

Unknown shortcuts are left unchanged.

Options

Custom Shortcuts

const nizel = useNizel({
  plugins: [
    emojiPlugin({
      emojiMap: {
        ship: '🚢',
      },
    }),
  ],
});