Skip to main content

Emoji plugin for markdown-it-py.

Project description


Emoji plugin for markdown-it-py. Ported from

PyPI Python Version Code style: black Imports: isort License pdm-managed codecov


Choose your favorite!

pip install mdit-py-emoji
pdm add mdit-py-emoji
poetry add mdit-py-emoji


Use it just like other plugins!

from markdown_it import MarkdownIt
from mdit_py_emoji import emoji_plugin

md = MarkdownIt().use(emoji_plugin)

print(md.renderInline(":star: mdit-py-emoji! :star:"))
# ⭐ mdit-py-emoji! ⭐
print(md.renderInline("Is shortcut supported too :/? :white_check_mark:"))
# Is shortcut supported too 😕? ✅


Pass defs and shortcuts and that's it!

from markdown_it import MarkdownIt
from mdit_py_emoji import emoji_plugin

md = MarkdownIt().use(
        "arrow_up": [":up_arrow:", ":up_arr:"],
        "arrow_down": [":down_arrow:", ":down_arr:"],
)  # Some tricks like `false = False`
print(md.renderInline(":down_arr: Go Down :down_arrow:"))
# ⬇️ Go Down ⬇️

Wondering about the defaults? Check !

Note: twemoji shortcuts are enabled by default. pass shortcuts={} to disable it.


This project is licensed under MIT License.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdit-py-emoji-0.1.1.tar.gz (21.0 kB view hashes)

Uploaded source

Built Distribution

mdit_py_emoji-0.1.1-py3-none-any.whl (20.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page