416

I am fairly new to markup (though it's extremely easy to pickup). I am working on a package and am trying to get the wiki pages looking nice as a help manual. I can insert a YouTube video link into the wiki page pretty easily but how do I embed a YouTube video. I know this may not be possible.

I have read you can use HTML tags so I tried embedding with HTML per this link as follows:

<object width="425" height="350">
  <param name="movie" value="http://www.youtube.com/user/wwwLoveWatercom?v=BTRN1YETpyg" />
  <param name="wmode" value="transparent" />
  <embed src="http://www.youtube.com/user/wwwLoveWatercom?v=BTRN1YETpyg"
         type="application/x-shockwave-flash"
         wmode="transparent" width="425" height="350" />
</object>

And saved the page but nothing happened.

  1. Is it possible to embed a YouTube video on GitHub wiki pages?
  2. If so how?
damon
  • 13,742
  • 14
  • 53
  • 73
Tyler Rinker
  • 103,777
  • 62
  • 306
  • 498

15 Answers15

654

It's not possible to embed videos directly, but you can put an image which links to a YouTube video:

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](https://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)
Eduardo Santana
  • 5,291
  • 3
  • 18
  • 21
MGA
  • 6,745
  • 1
  • 13
  • 10
374

Complete Example

Expanding on @MGA's Answer

While it's not possible to embed a video in Markdown you can "fake it" by including a valid linked image in your markup file, using this format:

[![IMAGE ALT TEXT](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE "Video Title")

Explanation of the Markdown

If this markup snippet looks complicated, break it down into two parts:

an image
![image alt text](https://example.com/link-to-image)
wrapped in a link
[link text](https://example.com/my-link "link title")

Example using Valid Markdown and YouTube Thumbnail:

Everything Is AWESOME

We are sourcing the thumbnail image directly from YouTube and linking to the actual video, so when the person clicks the image/thumbnail they will be taken to the video.

Code:

[![Everything Is AWESOME](https://img.youtube.com/vi/StTqXEQ2l-Y/0.jpg)](https://www.youtube.com/watch?v=StTqXEQ2l-Y "Everything Is AWESOME")

OR If you want to give readers a visual cue that the image/thumbnail is actually a playable video, take your own screenshot of the video in YouTube and use that as the thumbnail instead.

Example using Screenshot with Video Controls as Visual Cue:

Everything Is AWESOME

Code:

[![Everything Is AWESOME](http://i.imgur.com/Ot5DWAW.png)](https://youtu.be/StTqXEQ2l-Y?t=35s "Everything Is AWESOME")

 Clear Advantages

While this requires a couple of extra steps (a) taking the screenshot of the video and (b) uploading it so you can use the image as your thumbnail it does have 3 clear advantages:

  1. The person reading your markdown (or resulting html page) has a visual cue telling them they can watch the video (video controls encourage clicking)
  2. You can chose a specific frame in the video to use as the thumbnail (thus making your content more engaging)
  3. You can link to a specific time in the video from which play will start when the linked-image is clicked. (in our case from 35 seconds)

Taking and uploading a screenshot takes a few seconds but has a big payoff.

Works Everywhere!

Since this is standard markdown, it works everywhere. try it on GitHub, Reddit, Ghost, and here on Stack Overflow.

Vimeo

This approach also works with Vimeo videos

Example

Little red riding hood

Code

[![Little red riding hood](http://i.imgur.com/7YTMFQp.png)](https://vimeo.com/3514904 "Little red riding hood - Click to Watch!")

Notes:

nelsonic
  • 28,855
  • 20
  • 86
  • 114
  • 4
    I recently found that I had to omit the http / https URL scheme from the URL to get this to work, i.e. `[![Everything Is AWESOME](//img.youtube.com/vi/StTqXEQ2l-Y/0.jpg)](//www.youtube.com/watch?v=StTqXEQ2l-Y "Everything Is AWESOME")` – Stephen Quan Jul 22 '16 at 05:50
  • 1
    @StephenQuan which markdown parser/platform were you using? we use the code *with* the `http` or `https` on GitHub e.g: https://github.com/dwyl/remote-working where the video image and link work... – nelsonic Sep 06 '16 at 11:23
  • 1
    You can switch between the image quality of the thumbnail by replacing the `0.jpg` with `hqdefault.jpg` or `maxresdefault.jpg`. https://img.youtube.com/vi/StTqXEQ2l-Y/0.jpg https://img.youtube.com/vi/StTqXEQ2l-Y/hqdefault.jpg https://img.youtube.com/vi/StTqXEQ2l-Y/maxresdefault.jpg – Mahmoud K. Aug 31 '21 at 00:03
53

Markdown does not officially support video embeddings but you can embed raw HTML in it. I tested out with GitHub Pages and it works flawlessly.

  1. Go to the Video page on YouTube and click on the Share Button
  2. Choose Embed
  3. Copy and Paste the HTML snippet in your markdown

The snippet looks like:

    <iframe width="560" height="315"
src="https://www.youtube.com/embed/MUQfKFzIOeU" 
frameborder="0" 
allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" 
allowfullscreen></iframe>

PS: You can check out the live preview here

rynop
  • 45,628
  • 23
  • 95
  • 103
Daksh Shah
  • 2,715
  • 4
  • 34
  • 68
38

I created https://yt-embed.herokuapp.com/ to simplify this. The usage is direct, from the examples above:

[![Everything Is AWESOME](https://yt-embed.herokuapp.com/embed?v=StTqXEQ2l-Y)](https://www.youtube.com/watch?v=StTqXEQ2l-Y "Everything Is AWESOME")

Will result in: example of usage of yt-embed

Just make a call to: https://yt-embed.herokuapp.com/embed?v=[video_id] as the image instead of https://img.youtube.com/vi/.

M. hasbini
  • 509
  • 6
  • 7
  • 2
    Just a note that a web service like this might occasionally go offline. Make sure you use helpful alt-text for the inevitable event that their server/app goes offline. Also, make sure you're comfortable with updating your readmes when needed. (the app is currently offline at the time this comment was posted) – Brandon Bahret Jul 29 '21 at 03:17
  • This app is so great. I've used it many times. It's just unfortunate that it's offline quite often – mikabytes Aug 30 '21 at 08:56
  • To have it more reliable, you could of course host the app yourself or align with the maintainer to upgrade the heroku tier. – Kjell Oct 18 '21 at 10:28
  • I hosted the service on a dedicated server so that it'll have less downtime hopefully. It's now https://yt-embed.live/ instead of https://yt-embed.herokuapp.com/ – M. hasbini May 08 '22 at 13:23
15

If you like HTML tags more than markdown + center alignment:

<div align="center">
  <a href="https://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE"><img src="https://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg" alt="IMAGE ALT TEXT"></a>
</div>
6

Adding a link with the thumbnail, originally used by YouTube is a solution, that works. The thumbnail, used by YouTube is accessible the following way:

  • if the official video link is:
    • https://www.youtube.com/watch?v=5yLzZikS15k
  • then the thumbnail is:
    • https://img.youtube.com/vi/5yLzZikS15k/0.jpg

Following this logic, the code below produces flawless results:

<div align="left">
      <a href="https://www.youtube.com/watch?v=5yLzZikS15k">
         <img src="https://img.youtube.com/vi/5yLzZikS15k/0.jpg" style="width:100%;">
      </a>
</div>
Vityata
  • 41,328
  • 7
  • 50
  • 86
5

Center align Video with Thumbnail and Link:

<div align="center">
      <a href="https://www.youtube.com/watch?v=StTqXEQ2l-Y">
     <img 
      src="https://img.youtube.com/vi/StTqXEQ2l-Y/0.jpg" 
      alt="Everything Is AWESOME" 
      style="width:100%;">
      </a>
    </div>

Result:

enter image description here

Hitesh Sahu
  • 38,157
  • 14
  • 182
  • 142
  • This is a great answer because it is easy to automate! To that end, the template for that image link is `https://img.youtube.com/vi/ID_OF_VIDEO/0.jpg` and the API for forming image links is explained in detail in this answer: https://stackoverflow.com/a/2068371/55478 – Noah Sussman Feb 25 '20 at 19:46
4

I wrote a Chrome browser extension, xhub, that allows you to embed YouTube videos (and other things, too) in GitHub pages.

Get it here. Then add something like this

A video:
```youtube-embed
{
   "width": "560",
   "height": "315",
   "src": "https://www.youtube.com/embed/dQw4w9WgXcQ",
   "title": "YouTube video player",
   "frameborder": "0",
   "allow": "accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture",
   "allowfullscreen": true
}
```

to your markdown code. It gives you

enter image description here

Nico Schlömer
  • 46,467
  • 24
  • 178
  • 218
2

I create an api which let you Do it! You can go to This website to generate it or use the api. This api also allows you to Set size too! docs

[![ALT](https://youtube-md.vercel.app/VIDEO-ID)](https://www.youtube.com/watch?v=VIDEO-ID)

Example:

[![Rick Astley - Never Gonna Give You Up (Official Music Video)](https://youtube-md.vercel.app/dQw4w9WgXcQ/640/360)](https://www.youtube.com/watch?v=dQw4w9WgXcQ)

Rick Astley - Never Gonna Give You Up (Official Music Video)

Harry Tom
  • 183
  • 1
  • 11
1

In my case, as a trick I have encountered this issue by converting my screen recorded video into a gif using an online converter then I have added it to my markdown like so:

## Quick Overview of the project

![Functional Programming with Javascript using NASA API](./functionJsWithNasaAPI.gif)

The result was like this in the image below

Check this repo for a live preview of the example above. Hope this trick may help someone :).

Example of using a gif instead of using the unsupported video in the markdown

DINA TAKLIT
  • 4,804
  • 9
  • 56
  • 64
0

If you are trying to embed a video on a GitHub page all you need to do is go to the youtube video, click on share, copy the embed code (it should look like this)

<iframe width="560" height="315" src="https://www.youtube.com/embed/Z7PExj_v-ZU" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

and paste it to your markdown page.

luciferchase
  • 499
  • 1
  • 8
  • 20
  • Can confirm this works on markdown renderers that support embedded video. – Matthew Muller Jul 17 '21 at 07:00
  • This doesn't work on regular GitHub README's, on GitHub itself. And it also doesn't work on GitHub wiki pages, on GitHub itself. Tested and tried with my own project. :-) jz – J.Z. May 15 '22 at 17:38
0

Actually not only youtube, using a little trick you can upload any videos, even directly from your computer. To do that,

  • you can create an Issue and simply drag the video file in it
  • I always prefer a thumbnail, to do so, snapshot a picture from the video and drag it like previous step
  • you have now two urls from the video and image
  • use the urls as: [![img_tag](https://image-url.png)](https://video-url.mp4)
  • e.g.,

im1

  • simply close the issue now (if you want)
BiMo
  • 476
  • 5
  • 17
0

Replace my YouTube video's ID with your YouTube video's ID

<a href="https://youtu.be/5xwHkLPgvtQ" title="Music Caster Video Demo">
  <p align="center">
    <img width="75%" src="https://img.youtube.com/vi/5xwHkLPgvtQ/maxresdefault.jpg" alt="Music Caster Video Demo Thumbnail"/>
  </p>
</a>

html {
  background: #2D2D2D;
}
<a href="https://youtu.be/5xwHkLPgvtQ" title="Music Caster Video Demo">
  <p align="center">
    <img width="75%" src="https://img.youtube.com/vi/5xwHkLPgvtQ/maxresdefault.jpg" alt="Music Caster Video Demo Thumbnail"/>
  </p>
</a>

Real World Example

Elijah
  • 1,438
  • 17
  • 21
-1

You can try the following:

<iframe width="500" height="300" src="https://www.youtube.com/embed/<VIDEO_ID>" frameborder="0" allowfullscreen></iframe>
logbasex
  • 1,094
  • 1
  • 10
  • 15
-1

Now (2021) you can user video on gitHub markdown easily. You just need paste plain video url on your markdown, and it will be converted in video.


To have a video on your markdown, just add the video url, some like this:

https://www.youtube.com/watch?v=G3Cytlicv8Y

You can see on this video about this new feature.

Tiago Gouvêa
  • 13,018
  • 4
  • 68
  • 76
  • I watched the video you linked to, and yes you can embed a video file but it doesn't embed a link to an online YouTube video. At least, it did not work for me. (Note, one of the comments on the video says "It would be cool to have a similar integration with YouTube videos"). – Bill Jan 03 '22 at 19:23