Fix: Embed GitHub videos in docs site (remark plugin)#238
Merged
Conversation
Converts bare GitHub user-attachments/assets URLs into inline <video> elements, matching GitHub's native video embedding behavior. Also pins zod@3 to fix Starlight build compatibility.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
GitHub video URLs (e.g.
https://github.com/user-attachments/assets/<id>) render as inline video players on GitHub, but appear as plain text links on the Starlight docs site.Before: https://aws-solutions-library-samples.github.io/accelerated-intelligent-document-processing-on-aws/demo-videos/ showed 21 video URLs as text links
After: All 21 videos render as embedded
<video>players with play controls, matching GitHub's native behaviorSolution
Added a custom remark plugin (
docs-site/plugins/remark-github-video.mjs, ~50 lines) that:github.com/user-attachments/assets/URL<video controls>HTML elementsKey properties:
docs/*.mdfiles — the markdown continues working on GitHub exactly as beforeFiles changed
docs-site/plugins/remark-github-video.mjsdocs-site/astro.config.mjsdocs-site/src/styles/custom.cssdocs-site/package.jsonVerification
Built and deployed to GitHub Pages — 21 video tags confirmed in
dist/demo-videos/index.html.