remark-gemoji

remark plugin to turn gemoji shortcodes (:+1:) into emoji (👍).

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(remarkGemoji)
• Syntax
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This package is a unified (remark) plugin to turn gemoji shortcodes into emoji.

unified is a project that transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. This is a remark plugin that transforms mdast.

When should I use this?

You can use this plugin to match how GitHub turns gemoji (GitHub Emoji) shortcodes into emoji. This plugin does not support other platforms such as Slack and what labels they support.

A different plugin, remark-gfm, adds support for GFM (GitHub Flavored Markdown). GFM is a set of extensions (autolink literals, footnotes, strikethrough, tables, and tasklists) to markdown that are supported everywhere on GitHub.

Another plugin, remark-frontmatter, adds support for YAML frontmatter. GitHub supports frontmatter for files in Gists and repos.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install remark-gemoji

In Deno with esm.sh:

import remarkGemoji from 'https://esm.sh/remark-gemoji@7'

In browsers with esm.sh:

<script type="module">
  import remarkGemoji from 'https://esm.sh/remark-gemoji@7?bundle'
</script>

Use

Say we have the following file example.md:

Thumbs up: :+1:, thumbs down: :-1:.

Families: :family_man_man_boy_boy:

Some flags: :wales:, :scotland:, :england:.

And our module example.js looks as follows:

import {read} from 'to-vfile'
import {unified} from 'unified'
import remarkParse from 'remark-parse'
import remarkGemoji from 'remark-gemoji'
import remarkStringify from 'remark-stringify'

main()

async function main() {
  const file = await unified()
    .use(remarkParse)
    .use(remarkGemoji)
    .use(remarkStringify)
    .process(await read('example.md'))

  console.log(String(file))
}

Now running node example.js yields:

Thumbs up: 👍, thumbs down: 👎.

Families: 👨‍👨‍👦‍👦

Some flags: 🏴󠁧󠁢󠁷󠁬󠁳󠁿, 🏴󠁧󠁢󠁳󠁣󠁴󠁿, 🏴󠁧󠁢󠁥󠁮󠁧󠁿.

API

This package exports no identifiers. The default export is remarkGemoji.

unified().use(remarkGemoji)

Plugin to turn gemoji shortcodes (:+1:) into emoji (👍). There are no options.

Syntax

This plugin looks for the regular expression /:(\+1|[-\w]+):/g in text in markdown (excluding code and such). If the value between the two colons matches a know gemoji shortcode, then its replaced by the corresponding emoji.

In EBNF, the grammar looks as follows:

gemoji ::=  ':' ('+' '1' | character+) ':'
character ::= '-' | '_' | letter | digit
letter ::= letterLowercase | letterUppercase
letterLowercase ::= 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z'
letterUppercase ::= 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z'
digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

Types

This package is fully typed with TypeScript. There are no extra exported types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

This plugin works with unified version 3+ and remark version 4+.

Security

Use of remark-gemoji does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.

Related

• remark-gfm — support GFM (autolink literals, footnotes, strikethrough, tables, tasklists)
• remark-github — link references to commits, issues, pull-requests, and users, like on GitHub
• remark-breaks — support hard breaks without needing spaces or escapes
• remark-frontmatter — support frontmatter (YAML, TOML, and more)

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer