https://github.com/stamat/marked-github-emoji
marked extension to parse GitHub-style shortcodes into native system emojis
https://github.com/stamat/marked-github-emoji
emoji gemoji github markdown marked marked-extension shortcode
Last synced: about 22 hours ago
JSON representation
marked extension to parse GitHub-style shortcodes into native system emojis
- Host: GitHub
- URL: https://github.com/stamat/marked-github-emoji
- Owner: stamat
- License: mit
- Created: 2026-07-10T21:14:34.000Z (16 days ago)
- Default Branch: main
- Last Pushed: 2026-07-10T21:39:00.000Z (16 days ago)
- Last Synced: 2026-07-10T23:09:36.342Z (16 days ago)
- Topics: emoji, gemoji, github, markdown, marked, marked-extension, shortcode
- Language: JavaScript
- Homepage:
- Size: 69.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# marked-github-emoji [](https://www.npmjs.com/package/marked-github-emoji)
A lightweight, zero-dependency `marked` extension to parse GitHub-style shortcodes into native system emojis.
Cause I just want emoji shortcodes that I'm used to in my MDs...
`emojis.json` emoji dictionary is generated directly from `https://api.github.com/emojis` and `https://raw.githubusercontent.com/github/gemoji/master/db/emoji.json` using the `npm run generate-dict` script.
Support for legendary :shipit:, :suspect:, :trollface:, :octocat:, :atom: (my good old friend 😢), :electron:, etc... that get rendered as an image.
## Installation
```bash
npm install marked-github-emoji
```
## Usage
```javascript
import { marked } from "marked";
import { markedGithubEmoji } from "marked-github-emoji";
marked.use(markedGithubEmoji());
const html = marked.parse("Hello :rocket: :+1:");
//
Hello 🚀 👍
```
Hi! :wave: Bye! :wave:
## License
MIT