diff --git a/README.md b/README.md index 95c60b4..f181d8a 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,13 @@ githubEmojis: enable: true className: github-emoji unicode: false + styles: localEmojis: ``` The filter will try to download the latest version of [Github Emojis][ghemojis] list. If the network is unavailable or too slow it will use the backup version. -- **className** - Image class name. For `:sparkles:` the filter will generate something like this: +- **className** - Image class name. For :sparkles: `:sparkles:` the filter will generate something like this: ```html :sparkles: @@ -57,6 +58,21 @@ The filter will try to download the latest version of [Github Emojis][ghemojis] }) ``` +- **style** - inline styles for the images. For example: + + ```yaml + githubEmojis: + styles: + display: inline + vertical-align: bottom + ``` + + outputs: + + ```html + + ``` + - **localEmojis** - You can specify your own list. An object or JSON string is valid. The filter will first check the `localEmojis` then fallback to the [Github Emojis][ghemojis] list. For example: @@ -79,6 +95,14 @@ The filter will try to download the latest version of [Github Emojis][ghemojis] arrow_right: https://path/to/arrow_right.png ``` +## Tag + +If you do not like the `::`-style keywords, you can always use tags: + +```html +{% github_emoji sparkles %} +``` + ## Helper You can also render a GitHub emoji from a template using the `github_emoji` helper: diff --git a/package.json b/package.json index f896a3c..ede5086 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "hexo-filter-github-emojis", - "version": "1.1.1", + "version": "1.4.1", "description": "A Hexo plugin that adds emojis support, using Github Emojis API", "main": "index", "repository": "crimx/hexo-filter-github-emojis",