Showcasing Your GitHub Project the Right (GIF) Way

Wang Yixuan
Sep 4, 2018 · 2 min read

How do you capture the attention of your potential hiring manager, future employer’s attention? If a picture is worth a thousand word, then a video is worth a million word. Having a video embedded within the README file makes it easier for readers to get a grasp of what you’ve been working on and (hopefully) put your resume into a top candidate list.

“A video is worth a million word”

So how do you add video into the README file?

Step 1: Convert or Capture Video into a GIF

First, it’s important to understand that GitHub’s README.md file is written in Markdown syntax, which does not allow a video to be directly embedded into file.

However, image files can be attached. Since GIF is a type of an image file, you can simply convert a video into a GIF and attach to README as such.

Bonus 1: Here is a link to a website that converts video to GIF for free! (https://ezgif.com/video-to-gif)

Online video to GIF converter

Bonus 2: Alternatively, you can use GIPHY Capture, a freeware that can capture video and save into GIF file automatically (‎GIPHY Capture. The GIF Maker on the Mac App Store)

GIPHY

*Note: A GIF video should ideally be shorter than 30 seconds. Remember there’s no replay and pause button…


Step 2: Upload the GIF file to your GitHub repository

Step 3: Add the following line to your README file where you want the GIF to appear

![alt-text](link)

Once added, you can then preview the GIF in the editor using the shortcut:<ctrl> + <shift> + <M>



Now sit back and enjoy the GIF way!

Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch
Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore
Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade