feat(minimessage): Update hover tag format (#756)

* Add example of using data component key value pairs for hover:show_item tag format

* Replace Markdown table with HTML table for hover tag format documentation and add documentation for data component key value pairs

* Add badge and aside for legacy format warning

* Remove unused import

* Replace <code> tags with backticks

* chore: add markdown extension for table spanning

---------

Co-authored-by: Matouš Kučera <mk@kcra.me>

Author: Privatech38

astro.config.ts

@@ -2,6 +2,7 @@ import starlight from "@astrojs/starlight";
 import svelte from "@astrojs/svelte";
 import d2 from "astro-d2";
 import { defineConfig } from "astro/config";
+import { extendedTableHandlers, remarkExtendedTable } from "remark-extended-table";
 import starlightLinksValidator from "starlight-links-validator";
 import starlightSidebarTopics from "starlight-sidebar-topics";
 import codeConstantsPlugin from "./src/utils/remark/code_const";
@@ -552,7 +553,13 @@ export default defineConfig({
     domains: ["assets.papermc.io"],
   },
   markdown: {
+    remarkRehype: {
+      handlers: {
+        ...extendedTableHandlers,
+      },
+    },
     remarkPlugins: [
+      remarkExtendedTable,
       [
         javadocPlugin,
         {

package.json

@@ -22,6 +22,7 @@
     "astro": "^6.1.3",
     "astro-contributors": "^0.8.0",
     "astro-d2": "^0.10.0",
+    "remark-extended-table": "^2.0.3",
     "sharp": "^0.34.5",
     "starlight-links-validator": "^0.20.1",
     "starlight-sidebar-topics": "^0.7.1",

pnpm-lock.yaml

@@ -5,6 +5,7 @@ description: The MiniMessage format documentation.
 ---
 
 import { Image } from "astro:assets";
+import { Badge } from "@astrojs/starlight/components";
 import Shadow1 from "./assets/shadow_1.png";
 import Shadow2 from "./assets/shadow_2.png";
 import Shadow3 from "./assets/shadow_3.png";
@@ -16,6 +17,7 @@ import Decoration1 from "./assets/decoration_1.png";
 import Reset1 from "./assets/reset_1.png";
 import Click1 from "./assets/click_1.png";
 import Hover1 from "./assets/hover_1.png";
+import Hover2 from "./assets/hover_2.png";
 import Key1 from "./assets/key_1.png";
 import Translatable1 from "./assets/translatable_1.png";
 import Translatable2 from "./assets/translatable_2.png";
@@ -229,26 +231,38 @@ like the `/say` or `/tell` command to prevent the server from sending signed mes
 Allows doing multiple things when hovering on the component.
 
 Tag
-  * `<hover:_action_:_value..._>`
+  * `<hover:_action_:_value_>`
 
 Arguments
   * `_action_`, the type of hover event, one of this [list](https://jd.advntr.dev/api/latest/net/kyori/adventure/text/event/HoverEvent.Action.html#field.summary)
-  * `_value..._`, arguments specific to each event action:
+  * `_value_`, argument(s) specific to each event action:
 
-| Action        | Value                                                                                                                     |
-|---------------|---------------------------------------------------------------------------------------------------------------------------|
-| `show_text`   | `_text_` (a MiniMessage string)                                                                                           |
-| `show_item`   | `_type_[:_count_[:tag]]` (a `Key` for the item's type, optionally followed by count (an integer) and tag (a SNBT string)) |
-| `show_entity` | `_type_:_uuid_[:_name_]` (a `Key` ID of the entity type, the entity's UUID, and an optional custom name)                  |
+[//]: # (FIXME: Starlight's padding doesn't apply for a spanned cell, so a manual padding is added)
+| Action        | Value                                                                                                      | Description                                                                                                                                                           |
+|---------------|------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `show_text`   | `_text_`                                                                                                   | a MiniMessage string                                                                                                                                                  |
+| `show_item`   | `_type_[:_count_[(:_componentKey_:_componentValue_)...]]`                                                  | a `Key` for the item's type, optionally followed by count (an integer) and a list of [data component](https://minecraft.wiki/w/Data_component_format) key value pairs |
+| ^             | <span style="padding-left: 1rem"><Badge variant="caution" text="Legacy" /> `_type_[:_count_[:tag]]`</span> | a `Key` for the item's type, optionally followed by count (an integer) and tag (a [SNBT](https://minecraft.wiki/w/NBT_format#SNBT_format) string)                     |
+| `show_entity` | `_type_:_uuid_[:_name_]`                                                                                   | a `Key` ID of the entity type, the entity's UUID, and an optional custom name                                                                                         |
+
+:::caution
+The `_type_[:_count_[:tag]]` value format for the `show_item` action is considered legacy and support for it may eventually be removed.
+The recommended format is `_type_[:_count_[(:_componentKey_:_componentValue_)...]]`.
+:::
 
 Examples
 ```mm
 <hover:show_text:'<red>test'>TEST
 ```
-
 <br/>
 <Image class="img-inline" alt="The result of parsing `<hover:show_text:'<red>test'>TEST`, shown in-game in the Minecraft client's chat window" src={Hover1} />
 
+```mm
+<hover:show_item:diamond_sword:1:enchantments:'{sharpness:3,knockback:2}'>Very sharp sword!</hover>
+```
+<br/>
+<Image class="img-inline" alt="<hover:show_item:diamond_sword:1:enchantments:'{sharpness:3,knockback:2}'>Very sharp sword!</hover>" src={Hover2} />
+
 ### Keybind
 
 Allows displaying the configured key for actions