:rocket: Asciidoctor Emoji Extension

An extension for Asciidoctor.js that turns emoji:heart[] into :heart: !

Install

Node.js

Install the dependencies:

$ npm i @asciidoctor/core asciidoctor-emoji

Create a file named emoji.js with following content and run it:

const asciidoctor = require('@asciidoctor/core')()
const emoji = require('asciidoctor-emoji')

const input = 'I emoji:heart[1x] Asciidoctor.js!'

emoji.register(asciidoctor.Extensions)
console.log(asciidoctor.convert(input)) // <1>

const registry = asciidoctor.Extensions.create()
emoji.register(registry)
console.log(asciidoctor.convert(input, {'extension_registry': registry})) // <2>

<1> Register the extension in the global registry <2> Register the extension in a dedicated registry ### Browser Install the dependencies: $ npm i @asciidoctor/core asciidoctor-emoji Create a file named `emoji.html` with the following content and open it in your browser: ```html ``` <1> Register the extension in the global registry <2> Register the extension in a dedicated registry ## Usage Use `emoji:` followed by the name of your emoji (and don't forget the square brackets). For instance `wink`: ```adoc emoji:wink[] ``` Additionally you can configure the size of an `emoji`. By default, the size is 24px but you can use one of the following: * `1x` (17px) * `lg` (24px) * `2x` (34px) * `3x` (50px) * `4x` (68px) * `5x` (85px) If you want a really big :bear:, use: ```adoc emoji:bear[5x] ``` You can also specify a size in pixel :tada: ```adoc emoji:tada[42px] ``` ## How ? This extension is using [Twemoji from Twitter](https://blog.twitter.com/developer/en_us/a/2014/open-sourcing-twitter-emoji-for-everyone.html). The `emoji` inline macro is converted into an `` that points to a remote SVG: ```adoc emoji:beetle[] ``` ```html ```