Skip to content

Commit ddf7ad2

Browse files
committed
Emoji docs tweaks
1 parent 9d522d5 commit ddf7ad2

File tree

2 files changed

+32
-10
lines changed

2 files changed

+32
-10
lines changed

docs/configuration.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ Note that if you are running an external script, e.g. an embedded jsfiddle demo,
403403
- type: `Boolean`
404404
- default: `false`
405405

406-
Render emoji shorthand codes using platform-native emoji characters instead of GitHub style emoji images.
406+
Render emoji shorthand codes using GitHub-style emoji images or platform-native emoji characters.
407407

408408
```js
409409
window.$docsify = {
@@ -419,7 +419,17 @@ window.$docsify = {
419419
:-1:
420420
```
421421

422-
When `true`:
422+
GitHub-style images when `false`:
423+
424+
<output data-lang="output">
425+
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f604.png" alt="smile">
426+
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f973.png" alt="partying_face">
427+
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f602.png" alt="joy">
428+
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png" alt="+1">
429+
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png" alt="-1">
430+
</output>
431+
432+
Platform-native characters when `true`:
423433

424434
<output data-lang="output">
425435
<span class="emoji">😄︎</span>
@@ -429,14 +439,16 @@ When `true`:
429439
<span class="emoji">👎︎</span>
430440
</output>
431441

432-
When `false`:
442+
To render shorthand codes as text, replace `:` characters with the `&colon;` HTML entity.
443+
444+
```markdown
445+
&colon;100&colon;
446+
```
433447

434448
<output data-lang="output">
435-
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f604.png" alt="smile">
436-
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f973.png" alt="partying_face">
437-
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f602.png" alt="joy">
438-
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png" alt="+1">
439-
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png" alt="-1">
449+
450+
&colon;100&colon;
451+
440452
</output>
441453

442454
## noEmoji
@@ -452,7 +464,17 @@ window.$docsify = {
452464
};
453465
```
454466

455-
To render individual shorthand codes as text, replace the surrounding `:` characters with the `&colon;` HTML entity.
467+
```markdown
468+
:100:
469+
```
470+
471+
<output data-lang="output">
472+
473+
&colon;100&colon;
474+
475+
</output>
476+
477+
To disable emoji parsing of individual shorthand codes, replace `:` characters with the `&colon;` HTML entity.
456478

457479
```markdown
458480
:100:

docs/emoji.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Emoji
22

3-
Below is a complete list of emoji shorthand codes. Emoji can be rendered using native emoji characters or GitHub-style emoji images using the [`nativeEmoji`](configuration#nativeemoji) configuration option.
3+
Below is a complete list of emoji shorthand codes. Docsify can be configured to render emoji using GitHub-style emoji images or native emoji characters using the [`nativeEmoji`](configuration#nativeemoji) configuration option.
44

55
<div style="display: grid; grid-template-columns: repeat(auto-fill, minmax(15em, 1fr));">
66

0 commit comments

Comments
 (0)