aboutsummaryrefslogtreecommitdiffstats
path: root/images/emoji/custom/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'images/emoji/custom/README.md')
-rw-r--r--images/emoji/custom/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/images/emoji/custom/README.md b/images/emoji/custom/README.md
new file mode 100644
index 000000000..96718270c
--- /dev/null
+++ b/images/emoji/custom/README.md
@@ -0,0 +1,17 @@
+# Custom site emojis
+
+Create a file called custom_emojis.json and add your custom emojis to this folder (or anywhere else you like).
+The content of custom_emojis.json should look as follows:
+
+```
+{
+ "some_emoji": {
+ "shortname": ":some_emoji:",
+ "filepath": "images/emoji/custom/some_emoji.png"
+ },
+ "another_emoji": {
+ "shortname": ":another_emoji:",
+ "filepath": "images/emoji/custom/another_emoji.png"
+ },
+}
+``` \ No newline at end of file