Bumped Version to 1.4.1
This commit is contained in:
parent
6467244677
commit
8e78eb76f8
2 changed files with 26 additions and 2 deletions
26
README.md
26
README.md
|
@ -24,12 +24,13 @@ githubEmojis:
|
||||||
enable: true
|
enable: true
|
||||||
className: github-emoji
|
className: github-emoji
|
||||||
unicode: false
|
unicode: false
|
||||||
|
styles:
|
||||||
localEmojis:
|
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.
|
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
|
```html
|
||||||
<img class="github-emoji" title=":sparkles:" alt=":sparkles:" src="https://assets-cdn.github.com/images/icons/emoji/unicode/2728.png" height="20" width="20">
|
<img class="github-emoji" title=":sparkles:" alt=":sparkles:" src="https://assets-cdn.github.com/images/icons/emoji/unicode/2728.png" height="20" width="20">
|
||||||
|
@ -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
|
||||||
|
<img class="github-emoji" style="display:inline;vertical-align:bottom" ...>
|
||||||
|
```
|
||||||
|
|
||||||
- **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.
|
- **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:
|
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
|
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
|
## Helper
|
||||||
|
|
||||||
You can also render a GitHub emoji from a template using the `github_emoji` helper:
|
You can also render a GitHub emoji from a template using the `github_emoji` helper:
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "hexo-filter-github-emojis",
|
"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",
|
"description": "A Hexo plugin that adds emojis support, using Github Emojis API",
|
||||||
"main": "index",
|
"main": "index",
|
||||||
"repository": "crimx/hexo-filter-github-emojis",
|
"repository": "crimx/hexo-filter-github-emojis",
|
||||||
|
|
Loading…
Reference in a new issue