docs: update readme (#9)

Author: ReenigneArcher

.markdownlint.yaml

@@ -151,7 +151,7 @@ MD028: true
 # https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md029.md
 MD029:
   # List style
-  style: "one_or_ordered"
+  style: "ordered"
 
 # MD030/list-marker-space : Spaces after list markers
 # https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md030.md

README.md

@@ -3,3 +3,53 @@
 This is a central repository of all the commands that the [support-bot](https://github.com/LizardByte/support-bot)
 can execute. The purpose of separating the commands from the bot is to allow for easier updating and
 maintenance of the commands.
+
+The commands should be single markdown files and must comply with the following:
+
+| Element                         | Discord                | Reddit                 |
+|---------------------------------|------------------------|------------------------|
+| Headings[^1]                    | :heavy_check_mark:     | :heavy_check_mark:     |
+| Paragraphs[^2]                  | :warning:[^3]          | :heavy_check_mark:     |
+| Line Breaks                     | :x:                    | :heavy_check_mark:     |
+| Bold                            | :warning:[^4]          | :heavy_check_mark:     |
+| Italic                          | :heavy_check_mark:     | :heavy_check_mark:     |
+| Blockquotes                     | :heavy_check_mark:[^5] | :heavy_check_mark:     |
+| Ordered Lists                   | :heavy_check_mark:     | :heavy_check_mark:[^6] |
+| Unordered Lists                 | :heavy_check_mark:     | :warning:[^7]          |
+| Code                            | :heavy_check_mark:     | :heavy_check_mark:     |
+| Horizontal Rules                | :x:                    | :heavy_check_mark:     |
+| Links                           | :heavy_check_mark:     | :heavy_check_mark:     |
+| Images                          | :x:                    | :x:                    |
+| Tables                          | :x:                    | :heavy_check_mark:     |
+| Fenced Code Blocks              | :heavy_check_mark:     | :heavy_check_mark:     |
+| Syntax Highlighting             | :heavy_check_mark:     | :x:[^8]                |
+| Footnotes                       | :x:                    | :x:                    |
+| Heading IDs                     | :x:                    | :warning:[^9]          |
+| Definition Lists                | :x:                    | :x:                    |
+| Strikethrough                   | :heavy_check_mark:     | :heavy_check_mark:     |
+| Task Lists                      | :x:                    | :x:                    |
+| Emoji                           | :heavy_check_mark:     | :warning:[^10]         |
+| Highlight                       | :x:                    | :x:                    |
+| Subscript                       | :x:                    | :x:                    |
+| Superscript                     | :x:                    | :heavy_check_mark:     |
+| Automatic URL Linking           | :heavy_check_mark:     | :heavy_check_mark:     |
+| Disabling Automatic URL Linking | :heavy_check_mark:     | :heavy_check_mark:     |
+| HTML                            | :x:                    | :x:                    |
+
+:information_source: Do not use features that are not supported by all targets. For example, do not use line breaks,
+since it is not supported by Discord.
+
+For more information see the [Discord Markdown Guide](https://www.markdownguide.org/tools/discord/) or the
+[Reddit Markdown Guide](https://www.markdownguide.org/tools/reddit/).
+
+[^1]: A heading is required in every file.
+[^2]: Do not exceed 120 characters.
+[^3]: Discord does not natively support paragraphs, but we post process the markdown to handle it.
+[^4]: Use asterisks. Underscores aren't supported.
+[^5]: You can use `>>>` to create a multi-line blockquote.
+      All text from the `>>>` to the end of the message will be included in the quote.
+[^6]: Lists must start with the number 1.
+[^7]: Cannot use plus signs (+).
+[^8]: Reddit doesn't support syntax highlighting, but it should be okay to use anyway.
+[^9]: Automatically generated. There's no way to set custom heading IDs.
+[^10]: Emoji shorcodes are not supported. Paste the emoji directly.

docs/sunshine/vban.md

@@ -14,7 +14,7 @@ configuration as follows:
 
 That's it!
 
-:information_source: **Notes**
+ℹ️ **Notes**
 
 - As Receptor does not auto-start as it is not an installed program, you may want to add it as a
   Sunshine pre-launch command. Receptor will remember the last audio stream it was connected to.