Skip to content
This repository was archived by the owner on Mar 14, 2023. It is now read-only.

Commit fe57d11

Browse files
author
Bernhard Grünewaldt
committed
minor changes to readme
1 parent fb7425e commit fe57d11

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GitBook Plugin: Advanced Emoji
22

3-
Transforms emojis like `:white_check_mark:` into real <img class="emoji" title=":white_check_mark:" alt=":white_check_mark:" src="https://assets-cdn.github.com/images/icons/emoji/unicode/2705.png" height="20" width="20" align="absmiddle"> emoji images using [emojify.js](https://github.com/hassankhan/emojify.js).
3+
Transforms emojis like `:white_check_mark:` into real <img src="https://codeclou.github.io/gitbook-plugin-advanced-emoji/doc/white_check_mark_20.png"/> emoji images using [emojify.js](https://github.com/hassankhan/emojify.js).
44

55
Please note that this plugin only works for **markdown** files. All other filetypes will just be ignored, and the plugin does nothing.
66

@@ -33,6 +33,21 @@ If you want for example occurences of emojis **not replaced** you will need to w
3333
<!-- ignore:advanced-emoji:end -->
3434
```
3535

36+
You can even set the ignores around a codeblock or more lines.
37+
38+
```
39+
This is a text
40+
41+
<!-- ignore:advanced-emoji:start -->
42+
Check the Code
43+
```
44+
Code ... :white_check_mark:
45+
```
46+
<!-- ignore:advanced-emoji:end -->
47+
48+
foo
49+
```
50+
3651
## License
3752

3853
* https://github.com/codeclou/gitbook-plugin-advanced-emoji is licensed under MIT License

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "gitbook-plugin-advanced-emoji",
33
"description": "Shows the common emojis used on GitHub",
44
"main": "index.js",
5-
"version": "0.1.3",
5+
"version": "0.1.4",
66
"engines": {
77
"gitbook": ">=2.5.0"
88
},

0 commit comments

Comments
 (0)