docs: start basic faq

sVoxelDev · Mar 3, 2022 · 6d9022a · 6d9022a
1 parent 4ad9890
commit 6d9022a
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/faq.md b/docs/faq.md
@@ -0,0 +1,24 @@
+# FAQ
+
+Here are some of the most asked questions for sChat.
+
+??? faq "Are HEX Colors supported?"
+    Yes they are.  
+    Take a look at the [MiniMessage Format][minimessage] to learn more.
+
+??? faq "How can I add hover text to the player names?"
+    You can define a custom [`message_format`][message-format] and use the [MiniMessage Syntax][minimessage] to display information in the hover event.  
+    The use of [PlaceholderAPI][placeholderapi] placeholders is possible as well.
+
+    ```yaml
+    channels:
+      global:
+        name: Global
+        settings:
+          format:
+            message_format: "<hover:show_text:'World: <aqua>%player_world%</aqua>'><source_display_name></hover>: <text>"
+    ```
+
+[minimessage]: configuration/minimessage
+[message-format]: configuration/channels.md#message_format
+[placeholderapi]: extensions/placeholderapi
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,6 +11,7 @@ copyright: Copyright &copy; 2021 - 2022 sVoxelDev
 nav:
   - Home:
     - About sChat: index.md
+    - FAQ: faq.md
   - Getting Started:
     - getting-started.md
     - Commands: commands.md