Improve liquid doc indentation and hover formatting

----

- Render Description as markdown instead of plaintext
- Fix indentation for multi-line examples and descriptions

Author: jamesmengo

.changeset/cool-flowers-listen.md

@@ -0,0 +1,5 @@
+---
+'@shopify/theme-check-common': patch
+---
+
+Fix indentation for multi-line examples and descriptions

.changeset/few-planes-argue.md

@@ -0,0 +1,5 @@
+---
+'@shopify/theme-language-server-common': patch
+---
+
+Improve rendering of multi-line descriptions

packages/theme-check-common/src/liquid-doc/liquidDoc.spec.ts

@@ -129,7 +129,7 @@ describe('Unit: getSnippetDefinition', () => {
       liquidDoc: {
         examples: [
           {
-            content: '{{ product }}\n          {{ product.title }}',
+            content: '{{ product }}\n{{ product.title }}',
             nodeType: 'example',
           },
         ],
@@ -276,7 +276,7 @@ describe('Unit: getSnippetDefinition', () => {
       name: 'product-card',
       liquidDoc: {
         description: {
-          content: 'this is an implicit description\n        in a header',
+          content: 'this is an implicit description\nin a header',
           nodeType: 'description',
         },
         parameters: [

packages/theme-check-common/src/liquid-doc/liquidDoc.ts

@@ -68,13 +68,13 @@ export function getSnippetDefinition(
     },
     LiquidDocExampleNode(node: LiquidDocExampleNode) {
       return {
-        content: node.content.value.trim(),
+        content: fixIndentation(node.content.value.trim()),
         nodeType: 'example',
       };
     },
     LiquidDocDescriptionNode(node: LiquidDocDescriptionNode) {
       return {
-        content: node.content.value.trim(),
+        content: fixIndentation(node.content.value.trim()),
         nodeType: 'description',
       };
     },
@@ -108,3 +108,27 @@ export function getSnippetDefinition(
     },
   };
 }
+
+function fixIndentation(text: string): string {
+  const lines = text.split('\n');
+
+  if (lines.length <= 1) return text;
+
+  const nonEmptyLines = lines.slice(1).filter((line) => line.trim().length > 0);
+  const indentLengths = nonEmptyLines.map((line) => {
+    const match = line.match(/^\s*/);
+    return match ? match[0].length : 0;
+  });
+
+  if (indentLengths.length === 0) return text;
+
+  const minIndent = Math.min(...indentLengths);
+
+  return [
+    lines[0],
+    ...lines.slice(1).map((line) => {
+      if (line.trim().length === 0) return line; // Skip empty lines
+      return line.slice(minIndent);
+    }),
+  ].join('\n');
+}

packages/theme-language-server-common/src/hover/providers/RenderSnippetHoverProvider.spec.ts

@@ -75,9 +75,7 @@ describe('Module: RenderSnippetHoverProvider', async () => {
 **Description:**
 
 
-\`\`\`plaintext
 This is a description
-\`\`\`
 
 **Parameters:**
 - \`title\`: string - The title of the product

packages/theme-language-server-common/src/hover/providers/RenderSnippetHoverProvider.ts

@@ -51,7 +51,7 @@ export class RenderSnippetHoverProvider implements BaseHoverProvider {
 
     if (liquidDoc.description) {
       const description = liquidDoc.description.content;
-      parts.push('', '**Description:**', '\n', `\`\`\`plaintext\n${description}\n\`\`\``);
+      parts.push('', '**Description:**', '\n', description);
     }
 
     if (liquidDoc.parameters?.length) {