aboutsummaryrefslogtreecommitdiff
path: root/docs/Custom-Emoji.md
diff options
context:
space:
mode:
authorWilliam Pearson <uiri00@gmail.com>2019-01-20 01:44:00 +0000
committerWilliam Pearson <uiri00@gmail.com>2019-03-15 02:28:18 +0000
commit3dadaa4432b442d75b0ac0425aa05527d52f0e7a (patch)
tree84b54ea9b38a8765a3cdda450e4bf9d61a9e7c4c /docs/Custom-Emoji.md
parent4e72762322a5616ce426df62888ee3bc7af19dc8 (diff)
downloadpleroma-3dadaa4432b442d75b0ac0425aa05527d52f0e7a.tar.gz
robots.txt
Add default robots.txt that allows bots access to all paths. Add mix task to generate robots.txt taht allows bots access to no paths. Document custom emojis, MRF and static_dir static_dir documentation includes docs for the robots.txt Mix task.
Diffstat (limited to 'docs/Custom-Emoji.md')
-rw-r--r--docs/Custom-Emoji.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/Custom-Emoji.md b/docs/Custom-Emoji.md
new file mode 100644
index 000000000..d4af5c97c
--- /dev/null
+++ b/docs/Custom-Emoji.md
@@ -0,0 +1,16 @@
+To add custom emoji:
+* Add the image file(s) to `priv/static/emoji/custom`
+* In case of conflicts: add the desired shortcode with the path to `config/custom_emoji.txt`, comma-separated and one per line
+* Force recompilation (``mix clean && mix compile``)
+
+Example:
+
+image files (in `/priv/static/emoji/custom`): `happy.png` and `sad.png`
+
+content of `config/custom_emoji.txt`:
+```
+happy, /emoji/custom/happy.png
+sad, /emoji/custom/sad.png
+```
+
+The files should be PNG (APNG is okay with `.png` for `image/png` Content-type) and under 50kb for compatibility with mastodon.