Skip to content

Commit ce5d236

Browse files
committed
Add emoji section
1 parent 8b54ad5 commit ce5d236

File tree

6 files changed

+78
-2
lines changed

6 files changed

+78
-2
lines changed

_extended-syntax/emoji.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Emoji
3+
syntax-id: emoji
4+
---
5+
6+
There are two ways to add emoji to Markdown files: copy and paste the emoji into your Markdown-formatted text, or type *emoji shortcodes*.
7+
8+
### Copying and Pasting Emoji
9+
10+
In most cases, you can simply copy an emoji from a source like [Emojipedia](https://emojipedia.org/) and paste it into your document. Many Markdown applications will automatically display the emoji in the Markdown-formatted text. The HTML and PDF files you export from your Markdown application should display the emoji.
11+
12+
<div class="alert alert-success">
13+
<i class="fas fa-lightbulb"></i> <strong>Tip:</strong> If you're using a static site generator, make sure you <a href="https://www.w3.org/International/tutorials/tutorial-char-enc/">encode HTML pages as UTF-8</a>.
14+
</div>
15+
16+
### Using Emoji Shortcodes
17+
18+
Some Markdown applications allow you to insert emoji by typing emoji shortcodes. These begin and end with a colon and include the name of an emoji.
19+
20+
```text
21+
Gone camping! :tent: Be back soon.
22+
23+
That is so funny! :joy:
24+
```
25+
26+
The rendered output looks like this:
27+
28+
Gone camping! ⛺ Be back soon.
29+
30+
That is so funny! 😂
31+
32+
<div class="alert alert-info">
33+
<i class="fas fa-info-circle"></i> <strong>Note:</strong> You can use this <a href="https://gist.github.com/rxaviers/7360908">list of emoji shortcodes</a>, but keep in mind that emoji shortcodes vary from application to application. Refer to your Markdown application's documentation for more information.
34+
</div>

_extended-syntax/strikethrough.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ syntax-id: strikethrough
44
syntax-summary: "~~The world is flat.~~"
55
---
66

7-
You can "strikethrough" words by putting a horizontal line through the center of them. The result looks ~~like this~~. This feature allows you to indicate that certain words are a mistake not meant for inclusion in the document. To strikethrough words, use two tilde symbols (`~~`) before and after the words.
7+
You can strikethrough words by putting a horizontal line through the center of them. The result looks ~~like this~~. This feature allows you to indicate that certain words are a mistake not meant for inclusion in the document. To strikethrough words, use two tilde symbols (`~~`) before and after the words.
88

99
```
1010
~~The world is flat.~~ We now know that the world is round.

_tools/bear.md

+10
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,16 @@ Bear provides support for the following Markdown elements.
130130
<td class="table-success">Yes</td>
131131
<td></td>
132132
</tr>
133+
<tr>
134+
<td><a href="/extended-syntax/#copying-and-pasting-emoji">Emoji (copy and paste)</a></td>
135+
<td class="table-success">Yes</td>
136+
<td></td>
137+
</tr>
138+
<tr>
139+
<td><a href="/extended-syntax/#using-emoji-shortcodes">Emoji (shortcodes)</a></td>
140+
<td class="table-warning">Partial</td>
141+
<td>Type a colon, start typing the name of the emoji, and a menu with associated emoji will appear. Click an emoji to insert it in the document.</td>
142+
</tr>
133143
<tr>
134144
<td><a href="/extended-syntax/#automatic-url-linking">Automatic URL Linking</a></td>
135145
<td class="table-success">Yes</td>

_tools/jekyll.md

+10
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,16 @@ Jekyll provides support for the following Markdown elements. By default, Jekyll
126126
<td class="table-success">Yes</td>
127127
<td></td>
128128
</tr>
129+
<tr>
130+
<td><a href="/extended-syntax/#copying-and-pasting-emoji">Emoji (copy and paste)</a></td>
131+
<td class="table-success">Yes</td>
132+
<td></td>
133+
</tr>
134+
<tr>
135+
<td><a href="/extended-syntax/#using-emoji-shortcodes">Emoji (shortcodes)</a></td>
136+
<td class="table-danger">No</td>
137+
<td>Not supported by default, but you can use the <a href="https://github.com/jekyll/jemoji">jemoji</a> plugin to enable support.</td>
138+
</tr>
129139
<tr>
130140
<td><a href="/extended-syntax/#automatic-url-linking">Automatic URL Linking</a></td>
131141
<td class="table-success">Yes</td>

_tools/slack.md

+20
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,16 @@ The Slack message interface provides support for the following the Markdown elem
132132
<td class="table-danger">No</td>
133133
<td></td>
134134
</tr>
135+
<tr>
136+
<td><a href="/extended-syntax/#copying-and-pasting-emoji">Emoji (copy and paste)</a></td>
137+
<td class="table-success">Yes</td>
138+
<td></td>
139+
</tr>
140+
<tr>
141+
<td><a href="/extended-syntax/#using-emoji-shortcodes">Emoji (shortcodes)</a></td>
142+
<td class="table-success">Yes</td>
143+
<td></td>
144+
</tr>
135145
<tr>
136146
<td><a href="/extended-syntax/#automatic-url-linking">Automatic URL Linking</a></td>
137147
<td class="table-success">Yes</td>
@@ -270,6 +280,16 @@ The Slack post interface provides support for the following Markdown elements.
270280
<td class="table-danger">No</td>
271281
<td></td>
272282
</tr>
283+
<tr>
284+
<td><a href="/extended-syntax/#copying-and-pasting-emoji">Emoji (copy and paste)</a></td>
285+
<td class="table-success">Yes</td>
286+
<td></td>
287+
</tr>
288+
<tr>
289+
<td><a href="/extended-syntax/#using-emoji-shortcodes">Emoji (shortcodes)</a></td>
290+
<td class="table-success">Yes</td>
291+
<td></td>
292+
</tr>
273293
<tr>
274294
<td><a href="/extended-syntax/#automatic-url-linking">Automatic URL Linking</a></td>
275295
<td class="table-success">Yes</td>

extended-syntax.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: Extended Syntax
44
description: Advanced features that build on the basic Markdown syntax.
5-
last_modified_at: 2019-10-18
5+
last_modified_at: 2020-02-22
66
---
77

88
{% include syntax.html type="extended" syntax-id="overview" %}
@@ -23,4 +23,6 @@ last_modified_at: 2019-10-18
2323

2424
{% include syntax.html type="extended" syntax-id="task-lists" %}
2525

26+
{% include syntax.html type="extended" syntax-id="emoji" %}
27+
2628
{% include syntax.html type="extended" syntax-id="automatic-url-linking" %}

0 commit comments

Comments
 (0)