feat: support markdown JSDoc for rich hover message description (#5890)

serkodev · web-flow · commit 3417c375c057 · 2025-12-19T09:45:11.000+08:00
diff --git a/packages/language-service/lib/plugins/vue-template.ts b/packages/language-service/lib/plugins/vue-template.ts
@@ -563,8 +563,9 @@ export function create(
 					function printDescription(meta: { description?: string; type: string }) {
 						let desc = `<code>${meta.type}</code>`;
 						if (meta.description) {
-							desc = `${meta.description}<br>${desc}`;
-							desc = `<p>${desc}</p>`;
+							// blank line for terminate HTML to support markdown
+							// see: https://github.github.com/gfm/#example-118
+							desc = `\n\n${meta.description}<br>${desc}`;
 						}
 						return desc;
 					}

Original file line number	Diff line number	Diff line change
`@@ -563,8 +563,9 @@ export function create(`
`563`	`563`	`function printDescription(meta: { description?: string; type: string }) {`
`564`	`564`	let desc = `<code>${meta.type}</code>`;
`565`	`565`	`if (meta.description) {`
`566`		- desc = `${meta.description}<br>${desc}`;
`567`		- desc = `<p>${desc}</p>`;
	`566`	`+ // blank line for terminate HTML to support markdown`
	`567`	`+ // see: https://github.github.com/gfm/#example-118`
	`568`	+ desc = `\n\n${meta.description}<br>${desc}`;
`568`	`569`	`}`
`569`	`570`	`return desc;`
`570`	`571`	`}`