446

I want to add this animated GIF to a GitHub flavored markdown file. If it can't be done in GitHub, is it possible to do it in another version of Markdown?

Flimm
  • 136,138
  • 45
  • 251
  • 267
Zaynaib Giwa
  • 5,366
  • 7
  • 21
  • 26
  • Possible duplicate of [How to add screenshot to READMEs in github repository ?](http://stackoverflow.com/questions/10189356/how-to-add-screenshot-to-readmes-in-github-repository) or [Add images to README.md on github](http://stackoverflow.com/questions/14494747/add-images-to-readme-md-on-github?rq=1) – Michael Recachinas Dec 17 '15 at 18:40

13 Answers13

933

Showing gifs need two things

1- Use this syntax as in these examples

![Alt Text](https://media.giphy.com/media/vFKqnCdLPNOKc/giphy.gif)

Yields:

Alt Text

2- The image url must end with gif

3- For posterity: if the .gif link above ever goes bad, you will not see the image and instead see the alt-text and URL, like this:

Alt Text

4- for resizing the gif you can use this syntax as in this Github tutorial link

<img src="https://media.giphy.com/media/vFKqnCdLPNOKc/giphy.gif" width="40" height="40" />

Yields:

Khaled Annajar
  • 15,542
  • 5
  • 34
  • 45
133

From the Markdown Cheatsheet:

You can add it to your repo and reference it with an image tag:

Inline-style: 
![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 1")

Reference-style: 
![alt text][logo]

[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 2"

Inline-style: alt text

Reference-style: alt text


Alternatively you can use the url directly:

![](http://www.reactiongifs.us/wp-content/uploads/2013/10/nuh_uh_conan_obrien.gif)
erip
  • 16,374
  • 11
  • 66
  • 121
32
  1. have gif file.
  2. push gif file to your github repo
  3. click on that file on the github repo to get github address of the gif
  4. in your README file: ![alt-text](link)

example below: ![grab-landing-page](https://github.com/winnie1312/grab/blob/master/grab-landingpage-winnie.gif)

Nhu Phan
  • 699
  • 7
  • 4
27

just upload the .gif file into your base folder of GitHub and edit README.md just use this code

![](name-of-giphy.gif)

Vishal Shelake
  • 572
  • 1
  • 8
  • 12
13

Upload from local:

  1. Add your .gif file to the root of Github repository and push the change.
  2. Go to README.md
  3. Add this ![Alt text](name-of-gif-file.gif) / ![](name-of-gif-file.gif)
  4. Commit and gif should be seen.

Show the gif using url:

  1. Go to README.md
  2. Add in this format ![Alt text](https://sample/url/name-of-gif-file.gif)
  3. Commit and gif should be seen.

Hope this helps.

Sumit
  • 874
  • 9
  • 10
12

Giphy Gotcha

After following the 2 requirements listed above (must end in .gif and using the image syntax), if you are having trouble with a gif from giphy:

Be sure you have the correct giphy url! You can't just add .gif to the end of this one and have it work.

If you just copy the url from a browser, you will get something like:

https://giphy.com/gifs/gol-automaton-game-of-life-QfsvYoBSSpfbtFJIVo

You need to instead click on "Copy Link" and then grab the "GIF Link" specifically. Notice the correct one points to media.giphy.com instead of just giphy.com:

https://media.giphy.com/media/QfsvYoBSSpfbtFJIVo/giphy.gif

Jordan Arnesen
  • 413
  • 5
  • 10
8

Another simpler way is to open your git repository in your browser (chrome), click on edit README.md

then just drag drop your gif/png/jpeg file from your local machine disk and automatically the file will be uploaded and link will be placed in README.md file, like shown below

![myfile](https://user-images.githubusercontent.com/52455330/139071980-91302a8a-37b1-4196-803e-f91b1de2ee5b.gif)

myfile

The file you wanted to be added

myfile

![myfile](https://www.reactiongifs.us/wp-content/uploads/2013/10/nuh_uh_conan_obrien.gif)
Santosh Karanam
  • 1,077
  • 11
  • 23
5

If you can provide your image in SVG format (it is an icon and not a photo), it can be animated with SVG SMIL animations and SVG would be definitely the superior alternative to GIF images (or even other formats).

SVG, like other image formats, can be used with either standard markup or HTML <img> element:

![image description](path/in/repository/to/image.svg)
<img src="path/in/repository/to/image.svg" width="128"/>
Mahozad
  • 18,032
  • 13
  • 118
  • 133
5

Using HTML's img tag then giving a source url.

<img src="https://...thumbs-up.gif">

enter image description here

Njuguna_nc
  • 257
  • 3
  • 11
2

in addition to all answers above:

if you want to use a gif for your github repository README.md and don't want to address it from your root directory, it's not enough if you just copy the url of your browser, for example your browser URL is sth like:

https://github.com/ashkan-nasirzadeh/simpleShell/blob/master/README%20assets/shell-gif.gif

but you should open your gif in your github account and right click on it and click copy image address or sth like that which is sth like this:

https://github.com/ashkan-nasirzadeh/simpleShell/blob/master/README%20assets/shell-gif.gif?raw=true

2

you can use ![ ](any link of image)

Also I would suggest to use https://stackedit.io/ for markdown formating and wring it is much easy than remembering all the markdown syntax

Faizan.shaikh
  • 41
  • 1
  • 5
1

Convert the url from

https://github.com/nikhith265/submit_button_group/blob/master/attachments/gif/sample_gif.gif

to

https://raw.githubusercontent.com/nikhith265/submit_button_group/298c26b5a3fcfe936f16deef0e8712c2fdc1b635/attachments/gif/sample_gif.gif

NOTE: Make sure to remove /blob from url

Then use img tag as follows to add gif to .md

<img src="https://raw.githubusercontent.com/nikhith265/submit_button_group/298c26b5a3fcfe936f16deef0e8712c2fdc1b635/attachments/gif/sample_gif.gif" alt="gif" width="300" height="540">
Nikhith sunil
  • 229
  • 3
  • 4
1

The easiest way that I found to add a gif to a markdown file is just copy/paste. Nearly most of Microsoft's websites like GitHub, Stack Overflow support copying/pasting images and gifs.

If you have the file in your computer, then copy it and paste in any markdown file and it will be added automatically and uploaded to GitHub's server and formatted in the correct format with the name of the file.

enter image description here

Abou Emran
  • 183
  • 2
  • 12