Skip to content

Commit 2364007

Browse files
authored
Document video and image rendering instructions
Added guidelines for rendering videos and images correctly on the generated website.
1 parent 0b7797d commit 2364007

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Videos not working correctly?
2+
3+
Here are some steps to make sure all of your awesome videos render correctly:
4+
5+
1. Videos added by drag and drop will render correctly when viewed through GitHub, but need some extra tweaks to work in the final generated website.
6+
7+
8+
In your `README.md`, if you have a video link that looks like this:
9+
10+
```
11+
https://github.com/NA-MIC/ProjectWeek/assets/66890913/8f257f29-fa9c-4319-8c49-4138003eba27
12+
```
13+
14+
Update it to:
15+
16+
```html
17+
<video
18+
controls muted
19+
src="https://github.com/NA-MIC/ProjectWeek/assets/66890913/8f257f29-fa9c-4319-8c49-4138003eba27"
20+
style="max-height:640px; min-height: 200px">
21+
</video>
22+
```
23+
24+
2. Links to externally hosted videos (such as YouTube) will need an iframe. You can copy the correct iframe embedding code from the video, page itself, by clicking the Share button and then Embed
25+
26+
Replace:
27+
28+
```
29+
https://youtu.be/ZWxE5QcGvE8
30+
```
31+
32+
with
33+
34+
````html
35+
<iframe width="420" height="315" src="https://www.youtube.com/embed/ZWxE5QcGvE8">
36+
</iframe>
37+
````
38+
39+
## Images look squashed?
40+
41+
Edit the `img` tag for the image to have `width=800` and remove the height attribute

0 commit comments

Comments
 (0)