docute-emojify
Advanced tools
Comparing version 0.1.0 to 0.1.1
{ | ||
"name": "docute-emojify", | ||
"version": "0.1.0", | ||
"description": "Docute plugin for supporting GitHub style emoji within Markdown.", | ||
"version": "0.1.1", | ||
"description": "Docute plugin for supporting emoji aliases within Markdown.", | ||
"keywords": [ | ||
@@ -6,0 +6,0 @@ "docute", |
@@ -5,3 +5,3 @@ # docute-emojify | ||
[Docute](https://docute.js.org) plugin for supporting GitHub style emoji aliases within Markdown. Requires Docute >=2.9. | ||
[Docute](https://docute.js.org) plugin for supporting emoji aliases within Markdown. | ||
@@ -25,2 +25,4 @@ ## Installation | ||
This plugin requires Docute >=2.9. | ||
## Usage | ||
@@ -35,3 +37,3 @@ Emoji aliases will be replaced with their respective Unicode characters within your Markdown documents. For instance, | ||
> This is **Markdown** with ð¯ emoji support ð | ||
> This is **Markdown** with 💯 emoji support 👌 | ||
@@ -55,2 +57,16 @@ All emoji aliases are scraped from the [gemoji](https://github.com/github/gemoji) repository. | ||
This allows you to replace `:hundo:` with ð¯ and `:thunking:` or `:thonk:` with ð¤. | ||
This will replace `:hundo:` with 💯 and `:thunking:` or `:thonk:` with 🤔. | ||
### Blacklisting Aliases | ||
Aliases may be blacklisted by providing an array of aliases as the `blacklist` option. | ||
```js | ||
docuteEmojify({ | ||
blacklist: [ | ||
'100', | ||
'+1', | ||
], | ||
}); | ||
``` | ||
Now `:100:` and `:+1` will render as typed rather than as an emoji character. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Empty package
Supply chain riskPackage does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.
Found 1 instance in 1 package
75606
7
1754
69