Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markdown-it/markdown-it-emoji
Emoji syntax plugin for markdown-it markdown parser
https://github.com/markdown-it/markdown-it-emoji
Last synced: 2 days ago
JSON representation
Emoji syntax plugin for markdown-it markdown parser
- Host: GitHub
- URL: https://github.com/markdown-it/markdown-it-emoji
- Owner: markdown-it
- License: mit
- Created: 2014-12-21T03:33:23.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-14T21:00:06.000Z (6 months ago)
- Last Synced: 2024-10-29T22:12:10.289Z (6 days ago)
- Language: JavaScript
- Homepage: https://markdown-it.github.io/
- Size: 238 KB
- Stars: 726
- Watchers: 9
- Forks: 166
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Support: support/update.mjs
Awesome Lists containing this project
- awesome-github-star - markdown-it-emoji - it markdown parser | markdown-it | 671 | (JavaScript)
README
# markdown-it-emoji
[](https://github.com/markdown-it/markdown-it-emoji/actions/workflows/ci.yml)
[](https://www.npmjs.org/package/markdown-it-emoji)
[](https://coveralls.io/github/markdown-it/markdown-it-emoji?branch=master)
> Plugin for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser, adding emoji & emoticon syntax support. Also supports emoticons [shortcuts](https://github.com/markdown-it/markdown-it-emoji/blob/master/lib/data/shortcuts.js) like `:)`, `:-(`, and others.
__NOTE. v3 changed exports, see below.__
## Install
```bash
npm install markdown-it-emoji
```
## Use
### init
```js
//
// { full, light, bare } configs available.
//
// full: includes all available emojis support
// light: includes small subset of most useable emojis
// bare: no defaults
//
// Also CJS & UMD builds available in `dist/` folder of published package,
// if your env not supports ESM modules use.
//
import { full as emoji } from 'markdown-it-emoji'
import markdownit from 'markdown-it'
const md = markdownit().use(emoji/* , options */);
```
Options are not mandatory:
- __defs__ (Object) - rewrite available emoji definitions
- example: `{ name1: char1, name2: char2, ... }`
- __enabled__ (Array) - disable all emojis except whitelisted
- __shortcuts__ (Object) - rewrite default shortcuts
- example: `{ "smile": [ ":)", ":-)" ], "laughing": ":D" }`
_Differences in browser._ If you load the script directly into the page without
using a package system, the module will add itself globally with the name `markdownitEmoji`.
### change output
By default, emojis are rendered as appropriate unicode chars. But you can change
the renderer function as you wish.
Render as span blocks (for example, to use a custom iconic font):
```js
// ...
// initialize
md.renderer.rules.emoji = function(token, idx) {
return '';
};
```
Or use [twemoji](https://github.com/twitter/twemoji):
```js
// ...
// initialize
import twemoji from 'twemoji'
md.renderer.rules.emoji = function(token, idx) {
return twemoji.parse(token[idx].content);
};
```
__NB 1__. Read [twemoji docs](https://github.com/twitter/twemoji#string-parsing)!
In case you need more options to change image size & type.
__NB 2__. When using twemoji you can make image height match the line height with this
style:
```css
.emoji {
height: 1.2em;
}
```
### In your markdown file
```md
Hello from mars :satellite:
```
becomes
```
Hello from mars 📡
```