npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

docute-emojify

v0.2.0

Published

Docute plugin for transforming emoji aliases within Markdown.

Downloads

623

Readme

docute-emojify

npm npm

Docute plugin for transforming emoji aliases within Markdown.

Installation

Get the UMD build and load it before you initialize Docute inside your index.html file:

<script src="https://unpkg.com/docute-emojify"></script>

Then, configure the plugin.

docute.init({
  plugins: [
    docuteEmojify(),
  ],
});

This plugin requires Docute >=2.9.

Usage

Emoji aliases will be replaced with their respective Unicode characters within your Markdown documents. For instance,

This is **Markdown** with :100: emoji support :ok_hand:

will render as

This is Markdown with 💯 emoji support 👌

All emoji aliases are scraped from the gemoji repository.

Adding Aliases

You can add additional aliases for existing emoji by providing an aliases object when you configure the plugin.

docuteEmojify({
  aliases: {
    100: 'hundo',
    thinking: [
      'thunking',
      'thonk',
    ],
  },
});

This will replace :hundo: with 💯 and :thunking: or :thonk: with 🤔.

Blacklisting Aliases

Aliases may be blacklisted by providing an array of aliases as the blacklist option.

docuteEmojify({
  blacklist: [
    '100',
    '+1',
  ],
});

This will make :100: and :+1: render as typed rather than as an emoji character.

Emojifying Code

By default, aliases found in code formatting (i.e. surrounded by matching backticks) are not transformed. This behaviour can be toggled using the emojifyCode option.

docuteEmojify({
  emojifyCode: true,
});

We will now see

See emoji code below `:+1:`

```
:100:
```

render as

See emoji code below 👍

💯