How to embed a video into GitHub-README? So easy!
When we launch a product, we usually make a video to show our product’s functions and features. We also do this for our GitHub repository now.
However, how can we embed a video into a GitHub README?
In the past, we tried to add a video file to the repository, but the video file showed as a URL given the limitations of the platform. We also tried using markdown or HTML to embed a video, but it did not work at all.
Good news: Embedding a local video into a GitHub README is very easy now!
Just follow these steps:
1. Edit the README file on the GitHub online repository
The edit page url likes https://github.com/xumeng/ai-careers/edit/master/README.md
2. Drag the local video file to the edit panel
GitHub will uploading the file automatically, then it will showing a video asset url likes https://github.com/xumeng/ai-careers/assets/2187660/7362e4b8-6318-4cfc-af63-b8921455e434
3. Preview and commit the changes, We’re done!
GitHub README Demo: https://github.com/xumeng/ai-careers
References
https://amoxu.com/2024/05/23/en/2024-05-23-How-to-embed-a-video-into-GitHub-README/
