flex-development / micromark-extension-gemoji

micromark extensions to support gemoji

micromark-extension-gemoji

micromark extensions to support gemoji (:+1:)

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
• Syntax
• Types
• Contribute

What is this?

This package contains two extensions that add support for gemoji (GitHub Emoji) syntax in markdown to micromark.

Gemoji are the shortcodes that GitHub uses to represent emoji. For example, :grinning: can be used for 😀.

When should I use this?

TODO: when should i use this?

Install

This package is ESM only.

In Node.js (version 18+) with yarn:

yarn add @flex-development/micromark-extension-gemoji

See Git - Protocols | Yarn  for details regarding installing from Git.

In Deno with esm.sh:

import { gemoji, gemojiHtml } from 'https://esm.sh/@flex-development/micromark-extension-gemoji'

In browsers with esm.sh:

<script type="module">
  import { gemoji, gemojiHtml } from 'https://esm.sh/@flex-development/micromark-extension-gemoji'
</script>

Use

TODO: use

API

TODO: api

Syntax

TODO: syntax

Types

This package is fully typed with TypeScript.

Contribute

See CONTRIBUTING.md.