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

Commit fb7425e

Browse files
author
Bernhard Grünewaldt
committed
v0.1.3 with ignore flag and only working for markdown.
1 parent f46a415 commit fb7425e

File tree

3 files changed

+55
-6
lines changed

3 files changed

+55
-6
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# GitBook Plugin: Advanced Emoji
22

3-
Transforms emojis like `:white_check_mark:` into real :white_check_mark: emoji images using [emojify.js](https://github.com/hassankhan/emojify.js).
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).
4+
5+
Please note that this plugin only works for **markdown** files. All other filetypes will just be ignored, and the plugin does nothing.
46

57
## Installation
68

@@ -21,6 +23,16 @@ Be sure to activate the option from the `book.json` file:
2123
Then run `gitbook install` followed by either `gitbook serve` or `gitbook build`
2224

2325

26+
## Using Ignore Flags
27+
28+
If you want for example occurences of emojis **not replaced** you will need to wrap them in the following comments.
29+
30+
```
31+
<!-- ignore:advanced-emoji:start -->
32+
:white_check_mark:
33+
<!-- ignore:advanced-emoji:end -->
34+
```
35+
2436
## License
2537

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

index.js

Lines changed: 41 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
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.2",
5+
"version": "0.1.3",
66
"engines": {
77
"gitbook": ">=2.5.0"
88
},

0 commit comments

Comments
 (0)