rehype-twemoji
v0.0.6TypeScript
A rehype plugin to convert emoji to twemoji.
0/weekUpdated 1 years agoMITUnpacked: 5.7 KB
Published by NekoChan
npm install rehype-twemojiRehype Twemoji
A rehype plugin to convert emoji to twemoji.
Install
``
bash
pnpm i -D rehype-twemoji
`
Usage
`ts
import { rehypeTwemoji } from 'rehype-twemoji'
import type { RehypeTwemojiOptions } from 'rehype-twemoji'
...
{
rehypePlugins: [
[rehypeTwemoji, {
format: 'svg',
source: 'https://cdn.jsdelivr.net/gh/twitter/twemoji@latest',
} satisfies RehypeTwemojiOptions],
]
}
`
Input:
`md
Hello World 👋
`
Output:
`html
Hello World
![]()
src="https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/svg/1f44b.svg"
alt="👋"
aria-label="waving hand"
data-twemoji=""
/>
`
Options
- format: svg or png (default: svg)
- source: source of twemoji (default: https://cdn.jsdelivr.net/gh/twitter/twemoji@latest)
Styling
You can use data-twemoji attribute to style the emoji.
Here is an example of using with Tailwind CSS:
`css
[data-twemoji] {
@apply size-[1.2em] inline-block align-text-bottom;
}
``
License
MIT