{"id":28573703,"url":"https://github.com/remarkjs/remark-gemoji","last_synced_at":"2025-06-10T21:19:32.207Z","repository":{"id":46187369,"uuid":"51834182","full_name":"remarkjs/remark-gemoji","owner":"remarkjs","description":"plugin to turn gemoji shortcodes into emoji 👍","archived":false,"fork":false,"pushed_at":"2025-04-15T08:01:41.000Z","size":118,"stargazers_count":45,"open_issues_count":0,"forks_count":5,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-05-18T15:49:34.305Z","etag":null,"topics":["emoji","gemoji","markdown","remark","remark-plugin"],"latest_commit_sha":null,"homepage":"https://remark.js.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/remarkjs.png","metadata":{"funding":{"github":"unifiedjs","open_collective":"unified"},"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-16T12:28:46.000Z","updated_at":"2025-05-01T06:24:37.000Z","dependencies_parsed_at":"2024-06-18T16:58:08.398Z","dependency_job_id":"eb491255-51c8-4dc1-bfa6-f913b52c22da","html_url":"https://github.com/remarkjs/remark-gemoji","commit_stats":{"total_commits":104,"total_committers":2,"mean_commits":52.0,"dds":"0.038461538461538436","last_synced_commit":"fb4d8a5021f02384e180c17f72f40d8dc698bd46"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fremark-gemoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fremark-gemoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fremark-gemoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fremark-gemoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/remarkjs","download_url":"https://codeload.github.com/remarkjs/remark-gemoji/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fremark-gemoji/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259152785,"owners_count":22813227,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emoji","gemoji","markdown","remark","remark-plugin"],"created_at":"2025-06-10T21:19:06.547Z","updated_at":"2025-06-10T21:19:32.191Z","avatar_url":"https://github.com/remarkjs.png","language":"JavaScript","funding_links":["https://github.com/sponsors/unifiedjs","https://opencollective.com/unified"],"categories":[],"sub_categories":[],"readme":"# remark-gemoji\n\n[![Build][build-badge]][build]\n[![Coverage][coverage-badge]][coverage]\n[![Downloads][downloads-badge]][downloads]\n[![Size][size-badge]][size]\n[![Sponsors][sponsors-badge]][collective]\n[![Backers][backers-badge]][collective]\n[![Chat][chat-badge]][chat]\n\n**[remark][]** plugin to turn gemoji shortcodes (`:+1:`) into emoji (`👍`).\n\n## Contents\n\n*   [What is this?](#what-is-this)\n*   [When should I use this?](#when-should-i-use-this)\n*   [Install](#install)\n*   [Use](#use)\n*   [API](#api)\n    *   [`unified().use(remarkGemoji)`](#unifieduseremarkgemoji)\n*   [Syntax](#syntax)\n*   [Types](#types)\n*   [Compatibility](#compatibility)\n*   [Security](#security)\n*   [Related](#related)\n*   [Contribute](#contribute)\n*   [License](#license)\n\n## What is this?\n\nThis package is a [unified][] ([remark][]) plugin to turn gemoji shortcodes into\nemoji.\n\n## When should I use this?\n\nYou can use this plugin to match how GitHub turns gemoji (**G**itHub **E**moji)\nshortcodes into emoji.\nThis plugin does not support other platforms such as Slack and what labels they\nsupport.\n\nA different plugin, [`remark-gfm`][remark-gfm], adds support for GFM (GitHub\nFlavored Markdown).\nGFM is a set of extensions (autolink literals, footnotes, strikethrough, tables,\nand tasklists) to markdown that are supported everywhere on GitHub.\n\nAnother plugin, [`remark-frontmatter`][remark-frontmatter], adds support for\nYAML frontmatter.\nGitHub supports frontmatter for files in Gists and repos.\n\n## Install\n\nThis package is [ESM only][esm].\nIn Node.js (version 16+), install with [npm][]:\n\n```sh\nnpm install remark-gemoji\n```\n\nIn Deno with [`esm.sh`][esmsh]:\n\n```js\nimport remarkGemoji from 'https://esm.sh/remark-gemoji@8'\n```\n\nIn browsers with [`esm.sh`][esmsh]:\n\n```html\n\u003cscript type=\"module\"\u003e\n  import remarkGemoji from 'https://esm.sh/remark-gemoji@8?bundle'\n\u003c/script\u003e\n```\n\n## Use\n\nSay we have the following file `example.md`:\n\n```markdown\nLook, the moon :new_moon_with_face:\n\nHere’s a family :family_man_man_boy_boy:\n\nСлава Україні!  :ukraine:\n```\n\n…and a module `example.js`:\n\n```js\nimport remarkGemoji from 'remark-gemoji'\nimport remarkParse from 'remark-parse'\nimport remarkStringify from 'remark-stringify'\nimport {read} from 'to-vfile'\nimport {unified} from 'unified'\n\nconst file = await unified()\n  .use(remarkParse)\n  .use(remarkGemoji)\n  .use(remarkStringify)\n  .process(await read('example.md'))\n\nconsole.log(String(file))\n```\n\n…then running `node example.js` yields:\n\n```markdown\nLook, the moon 🌚\n\nHere’s a family 👨‍👨‍👦‍👦\n\nСлава Україні!  🇺🇦\n```\n\n## API\n\nThis package exports no identifiers.\nThe default export is [`remarkGemoji`][api-remark-gemoji].\n\n### `unified().use(remarkGemoji)`\n\nTurn gemoji shortcodes (`:+1:`) into emoji (`👍`).\n\n###### Parameters\n\nThere are no parameters.\n\n###### Returns\n\nTransform ([`Transformer`][unified-transformer]).\n\n## Syntax\n\nThis plugin looks for the regular expression `/:(\\+1|[-\\w]+):/g` in text in\nmarkdown (excluding code and such).\nIf the value between the two colons matches a know gemoji shortcode, then its\nreplaced by the corresponding emoji.\n\nIn EBNF, the grammar looks as follows:\n\n\u003cpre\u003e\u003ccode class=language-ebnf\u003e\u003ca id=s-gemoji href=#s-gemoji\u003egemoji\u003c/a\u003e ::=  ':' ('+' '1' | \u003ca href=#s-character\u003echaracter\u003c/a\u003e+) ':'\n\u003ca id=s-character href=#s-character\u003echaracter\u003c/a\u003e ::= '-' | '_' | \u003ca href=#s-letter\u003eletter\u003c/a\u003e | \u003ca href=#s-digit\u003edigit\u003c/a\u003e\n\u003ca id=s-letter href=#s-letter\u003eletter\u003c/a\u003e ::= \u003ca href=#s-letter-lowercase\u003eletterLowercase\u003c/a\u003e | \u003ca href=#s-letter-uppercase\u003eletterUppercase\u003c/a\u003e\n\u003ca id=s-letter-lowercase href=#s-letter-lowercase\u003eletterLowercase\u003c/a\u003e ::= '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'\n\u003ca id=s-letter-uppercase href=#s-letter-uppercase\u003eletterUppercase\u003c/a\u003e ::= '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'\n\u003ca id=s-digit href=#s-digit\u003edigit\u003c/a\u003e ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'\n\u003c/code\u003e\u003c/pre\u003e\n\n## Types\n\nThis package is fully typed with [TypeScript][].\nIt exports no additional types.\n\n## Compatibility\n\nProjects maintained by the unified collective are compatible with maintained\nversions of Node.js.\n\nWhen we cut a new major release, we drop support for unmaintained versions of\nNode.\nThis means we try to keep the current release line, `remark-gemoji@^8`,\ncompatible with Node.js 16.\n\nThis plugin works with `unified` version 3+ and `remark` version 4+.\n\n## Security\n\nUse of `remark-gemoji` does not involve **[rehype][]** (**[hast][]**) or user\ncontent so there are no openings for [cross-site scripting (XSS)][wiki-xss]\nattacks.\n\n## Related\n\n*   [`remark-gfm`](https://github.com/remarkjs/remark-gfm)\n    — support GFM (autolink literals, footnotes, strikethrough, tables,\n    tasklists)\n*   [`remark-github`](https://github.com/remarkjs/remark-github)\n    — link references to commits, issues, pull-requests, and users, like on\n    GitHub\n*   [`remark-breaks`](https://github.com/remarkjs/remark-breaks)\n    — support hard breaks without needing spaces or escapes\n*   [`remark-frontmatter`](https://github.com/remarkjs/remark-frontmatter)\n    — support frontmatter (YAML, TOML, and more)\n\n## Contribute\n\nSee [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways\nto get started.\nSee [`support.md`][support] for ways to get help.\n\nThis project has a [code of conduct][coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\u003c!-- Definitions --\u003e\n\n[build-badge]: https://github.com/remarkjs/remark-gemoji/workflows/main/badge.svg\n\n[build]: https://github.com/remarkjs/remark-gemoji/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-gemoji.svg\n\n[coverage]: https://codecov.io/github/remarkjs/remark-gemoji\n\n[downloads-badge]: https://img.shields.io/npm/dm/remark-gemoji.svg\n\n[downloads]: https://www.npmjs.com/package/remark-gemoji\n\n[size-badge]: https://img.shields.io/bundlejs/size/remark-gemoji\n\n[size]: https://bundlejs.com/?q=remark-gemoji\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[collective]: https://opencollective.com/unified\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[chat]: https://github.com/remarkjs/remark/discussions\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[esmsh]: https://esm.sh\n\n[health]: https://github.com/remarkjs/.github\n\n[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md\n\n[support]: https://github.com/remarkjs/.github/blob/main/support.md\n\n[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md\n\n[license]: license\n\n[author]: https://wooorm.com\n\n[hast]: https://github.com/syntax-tree/hast\n\n[rehype]: https://github.com/rehypejs/rehype\n\n[remark]: https://github.com/remarkjs/remark\n\n[remark-frontmatter]: https://github.com/remarkjs/remark-frontmatter\n\n[remark-gfm]: https://github.com/remarkjs/remark-gfm\n\n[typescript]: https://www.typescriptlang.org\n\n[unified]: https://github.com/unifiedjs/unified\n\n[unified-transformer]: https://github.com/unifiedjs/unified#transformer\n\n[wiki-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting\n\n[api-remark-gemoji]: #unifieduseremarkgemoji\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremarkjs%2Fremark-gemoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fremarkjs%2Fremark-gemoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremarkjs%2Fremark-gemoji/lists"}