Skip to content

Show a cover image on the GitHub dsh-plugin topic page - #33

Merged
flymysql merged 1 commit into
mainfrom
cursor/github-topic-cover-cace
Sep 16, 2026
Merged

flymysql merged 1 commit into
mainfrom
cursor/github-topic-cover-cace

Conversation

@flymysql

@flymysql flymysql commented Sep 16, 2026

Copy link
Copy Markdown
Owner

GitHub topic cards (https://github.com/topics/dsh-plugin) thumbnail in-repo README images with a relative path, the same pattern used by plugins like dsh-dream-skin (docs/screenshots/preview.png) and dsh-file-attachment (docs/demo.gif).

dsh-remote had screenshots, but they were pointed at jsDelivr (cdn.jsdelivr.net/gh/...). That CDN is fine for humans and npm, but GitHub’s topic crawler skips it, so the card showed no cover. usesCustomOpenGraphImage is also false (Social preview was never uploaded).

The cover

dsh-remote cover

Designed rather than cropped: wordmark, tagline and feature chips next to the real workspace picker in a window frame, on the #7a3ef3 accent already used by the topic badge.

docs/cover.html is the source of truth — edit the HTML and re-render with headless Chrome at 2×, then downscale to 1280×640 (command in docs/promote.md) so the type stays crisp. The screenshot inside the frame is the existing docs/ui-picker-panel.png, cropped by CSS to the dialog card so none of the dimmed page behind the modal shows.

Changes

  • docs/cover.png (1280×640, GitHub's recommended social size, under 1 MB) + docs/cover.html that renders it
  • Cover is the first image in README.md / README.zh.md
  • Existing settings/picker <img> tags switched from jsDelivr to docs/*.png
  • Cover listed in screenshots.json for marketplace previews

After merge, GitHub may take a little while to recrawl the topic page.

Optional extra (no public API): Settings → General → Social preview → Upload the same docs/cover.png so Slack/X unfurls match.

To show artifacts inline, enable in settings.

Open in Web Open in Cursor 

Topic cards scrape relative README images from the repo. jsDelivr CDN
URLs were skipped, which is why dsh-remote had no thumbnail next to
other dsh-plugin projects. Add a 1280x640 docs/cover.png crop of the
workspace picker and point README screenshots at local paths.

Co-authored-by: 兰州小红鸡 <flyphp@outlook.com>
@flymysql
flymysql marked this pull request as ready for review September 16, 2026 09:01
@flymysql
flymysql merged commit 4ce399d into main Sep 16, 2026
1 check passed
cursor Bot pushed a commit that referenced this pull request Sep 16, 2026
…fix

PR #33 already landed the relative-path README screenshots. Keep this
branch's designed docs/cover.png + cover.html, and fold in the 0.8.17
Windows remote-tree ENOENT fix from main.

Co-authored-by: 兰州小红鸡 <flyphp@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants