Render GitHub `user-attachments` videos in module READMEs (currently shown as plain links)
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- documentation, web-dev
Research direction
Start at the module README rendering path on nuxt.com and inspect how bare autolinks are currently handled. Compare the nuxt-studio README example and decide between recognizing user-attachments URLs directly or checking their Content-Type. Done means the video renders with native video controls instead of appearing as a plain link.
Written by the indexing model from the issue text.
Description
Description
On module pages, a bare https://github.com/user-attachments/assets/<id> URL in the upstream README (GitHub's drag-and-drop video idiom) renders as a <video> on GitHub, but on nuxt.com it falls through as an autolink and shows as a plain link.
Example: the demo on https://nuxt.com/modules/studio appears as a bare link instead of the video (source: the nuxt-studio README at https://github.com/nuxt-content/nuxt-studio/blob/main/README.md).
Details
These asset URLs are publicly reachable anonymously — https://github.com/user-attachments/assets/<id> returns a 302 to an S3 URL that serves Content-Type: video/mp4 and supports range requests (verified: 206 Partial Content with Accept-Ranges: bytes) — so a native <video controls> pointing at the URL should work without any proxy.
Proposed approaches
Detecting autolinked user-attachments asset URLs and rendering them as video would cover this.
Two possible approaches:
- Render bare
user-attachmentsautolinks (as opposed to![]()images) as<video>, since the bare-URL form is GitHub's video idiom. - Resolve each
user-attachmentsasset URL (HEAD/GET) and branch on the responseContent-Type—<video>forvideo/*,<img>forimage/*.
I'd appreciate it if you could let me know which direction you'd prefer.
I'd be happy to implement this, but I'd appreciate a maintainer confirming the approach (or preferred direction) before I open a PR.
References
Originally raised in nuxt-content/nuxt-studio#479.
- Dominant language
- TypeScript
- Stars
- 460
- Forks
- 281
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 93
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from nuxt/nuxt.com
-
Difficulty 1/5 Under an hour Newbie friendliness 55/100
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 52/100
Maintainers usually reply within 1 day
-
Difficulty 3/5 Half a day Newbie friendliness 48/100
nuxt/nuxt.com#2477 · 1 comment ·
Maintainers usually reply within 1 day
-
Add a Docker deployment guide to /deployPossibly taken @BobTheShoplifter claimed this 62 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
Maintainers usually reply within 1 day
Similar issues
-
calcite-ui-icons enhancement impact - p3 - not time sensitive needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Esri/calcite-design-system#15467 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
diegosouzapw/OmniRoute#18390 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
guilhermerodz/input-otp#157 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
davidjerleke/embla-carousel#1414 ·
Maintainers usually reply within 4 days