vscode插件市场详情页图片需绝对https链接,相对路径失效;displayname≤45字符、description≤120字符;仅支持标准gfm语法,禁用html/js;可用markdown preview enhanced预览渲染效果。

VSCode 插件市场详情页不显示 Markdown 图片?
VSCode Marketplace 渲染详情页时,README.md 中的图片路径必须为**绝对 HTTPS 链接**,相对路径(如 ./assets/logo.png)或本地 file:// 路径一律失效。这是最常导致首页“图裂”或排版错乱的根源。
实操建议:
- 把所有图片上传到 GitHub 仓库的
assets/目录(公开可访问),然后用 GitHub Raw 链接:例如https://raw.githubusercontent.com/username/ext-name/main/assets/icon.svg - 避免使用 GitHub 的预览链接(带
/blob/),它返回 HTML 页面而非图片资源;务必用/raw/路径 - SVG 图标推荐转成
base64内联(仅限小图标),可绕过跨域和 CDN 缓存问题:
插件详情页标题/描述被截断或 SEO 不友好?
Marketplace 会从 package.json 的 displayName 和 description 字段提取首屏信息,但它们有硬性长度限制:displayName ≤ 45 字符,description ≤ 120 字符 —— 超出部分会被省略,且不会进入搜索索引。
实操建议:
-
displayName别堆关键词,优先体现核心功能,比如用SQL Runner而非SQL Runner – Execute Queries, Format, Export (vscode extension) -
description前 80 字必须包含用户最关心的动词+对象,例如Run SQL queries directly in VS Code with syntax highlighting, auto-formatting, and result export. - 完整功能说明留在
README.md第一段,Marketplace 不解析它,但用户点击“Details”后会渲染,是真正的主文案区
语法高亮、代码块、表格在详情页里乱码或不渲染?
Marketplace 使用的是精简版 Markdown 解析器(类似 GitHub Flavored Markdown 的子集),不支持 HTML 标签、自定义 CSS、JS 交互,也不识别某些扩展语法(如 Mermaid、admonition)。
实操建议:
- 代码块必须用标准三重反引号 + 语言标识:
```json,不能只写```;不支持```ts:line-numbers这类插件语法 - 表格务必用管道符对齐(GitHub 风格),避免空行嵌套;列宽由内容撑开,无法用
width控制 - 禁用所有 HTML 标签(哪怕
<details></details>或<div style="...">),它们会被原样输出为文本,破坏排版<li>Emoji 可用 Unicode(✅),但不要用 <code>:white_check_mark:这类 GitHub 特有别名,Marketplace 不识别 - 用
vsce package打包生成.vsix文件,解压它(本质是 ZIP),检查根目录下package.json和README.md是否符合上述规范 - 将
README.md拖进 VS Code,安装插件Markdown Preview Enhanced,启用 “GitHub Mode”,它最接近 Marketplace 渲染逻辑 - 发布前先推送到 GitHub,用
https://vsmarketplacebadge.apphb.com/version-short/[publisher].[extension].svg等第三方 badge 测试链接有效性
如何预览 Marketplace 渲染效果而不发布?
VSCode 官方不提供沙箱预览工具,但你可以通过本地构建 + 模拟环境逼近真实效果。
实操建议:
真正卡住人的往往不是写得多好,而是某张图用了 /blob/ 路径,或者 description 多了两个字——Marketplace 不报错,只默默截断。











