Emoji support for league/commonmark

This extension adds UTF-8 emoji with Github tag for the league/commonmark PHP Markdown parsing engine, based on the CommonMark spec.

Installation

You can install the client with Composer:

composer require elgigi/commonmark-emoji

Version 2.x of the extension is designed for league/commonmark 2.x. Use version 1 for league/commonmark 1.x.

Usage

Extension can be added to any new Environment:

use League\CommonMark\CommonMarkConverter;
use League\CommonMark\Environment;
use ElGigi\CommonMarkEmoji\EmojiExtension;

$converter = new CommonMarkConverter();
$converter->getEnvironment()->addExtension(new EmojiExtension());

echo $converter->convertToHtml('This extension is great :smile:!');

Emoji list

| Code | Emoji | |------------------------------------------|----------------------------------------| | :+1: | :+1: | | :-1: | :-1: | | :100: | :100: | | :1234: | :1234: | | :1st_place_medal: | :1st_place_medal: | | :2nd_place_medal: | :2nd_place_medal: | | :3rd_place_medal: | :3rd_place_medal: | | :8ball: | :8ball: | | :a: | :a: | | :ab: | :ab: | | :abacus: | :abacus: | | :abc: | :abc: | | :abcd: | :abcd: | | :accept: | :accept: | | :adhesive_bandage: | :adhesive_bandage: | | :adult: | :adult: | | :aerial_tramway: | :aerial_tramway: | | :afghanistan: | :afghanistan: | | :airplane: | :airplane: | | :aland_islands: | :aland_islands: | | :alarm_clock: | :alarm_clock: | | :albania: | :albania: | | :alembic: | :alembic: | | :algeria: | :algeria: | | :alien: | :alien: | | :ambulance: | :ambulance: | | :american_samoa: | :american_samoa: | | :amphora: | :amphora: | | :anchor: | :anchor: | | :andorra: | :andorra: | | :angel: | :angel: | | :anger: | :anger: | | :angola: | :angola: | | :angry: | :angry: | | :anguilla: | :anguilla: | | :anguished: | :anguished: | | :ant: | :ant: | | :antarctica: | :antarctica: | | :antigua_barbuda: | :antigua_barbuda: | | :apple: | :apple: | | :aquarius: | :aquarius: | | :argentina: | :argentina: | | :aries: | :aries: | | :armenia: | :armenia: | | :arrow_backward: | :arrow_backward: | | :arrow_double_down: | :arrow_double_down: | | :arrow_double_up: | :arrow_double_up: | | :arrow_down: | :arrow_down: | | :arrow_down_small: | :arrow_down_small: | | :arrow_forward: | :arrow_forward: | | :arrow_heading_down: | :arrow_heading_down: | | :arrow_heading_up: | :arrow_heading_up: | | :arrow_left: | :arrow_left: | | :arrow_lower_left: | :arrow_lower_left: | | :arrow_lower_right: | :arrow_lower_right: | | :arrow_right: | :arrow_right: | | :arrow_right_hook: | :arrow_right_hook: | | :arrow_up: | :arrow_up: | | :arrow_up_down: | :arrow_up_down: | | :arrow_up_small: | :arrow_up_small: | | :arrow_upper_left: | :arrow_upper_left: | | :arrow_upper_right: | :arrow_upper_right: | | :arrows_clockwise: | :arrows_clockwise: | | :arrows_counterclockwise: | :arrows_counterclockwise: | | :art: | :art: | | :articulated_lorry: | :articulated_lorry: | | :artificial_satellite: | :artificial_satellite: | | :artist: | :artist: | | :aruba: | :aruba: | | :ascension_island: | :ascension_island: | | :asterisk: | :asterisk: | | :astonished: | :astonished: | | :astronaut: | :astronaut: | | :athletic_shoe: | :athletic_shoe: | | :atm: | :atm: | | :atom_symbol: | :atom_symbol: | | :australia: | :australia: | | :austria: | :austria: | | :auto_rickshaw: | :auto_rickshaw: | | :avocado: | :avocado: | | :axe: | :axe: | | :azerbaijan: | :azerbaijan: | | :b: | :b: | | :baby: | :baby: | | :baby_bottle: | :baby_bottle: | | :baby_chick: | :baby_chick: | | :baby_symbol: | :baby_symbol: | | :back: | :back: | | :bacon: | :bacon: | | :badger: | :badger: | | :badminton: | :badminton: | | :bagel: | :bagel: | | :baggage_claim: | :baggage_claim: | | :baguette_bread: | :baguette_bread: | | :bahamas: | :bahamas: | | :bahrain: