CODEWITHSUNDEEP
githubmarkdown
daisy
daisy

Reputation: 23581

How to add screenshot to READMEs in github repository?

Is it possible to place a screenshot in README file in a GitHub repository? What's the syntax?

Upvotes: 741

Views: 428710

Answers (20)

Rohullah Nabavi
Rohullah Nabavi

Reputation: 90

Please follow these steps: this worked for me

  1. Create a new issue on GitHub.
  2. Drag and drop an image onto the comment field or upload a photo.
  3. Wait for the upload process to finish.
  4. Copy the URL and use it in your Markdown files on GitHub (use that generated URL in your repository's readme).

Upvotes: 2

user3941146
user3941146

Reputation:

Even though there is already an accepted answer I would like to add another way to upload images to readme on GitHub.

  • You need to create issue in your repo
  • Drag and drop in the comment area your image
  • After link for the image is generated insert it to your readme

More details you can find here

Upvotes: 87

Junaed
Junaed

Reputation: 1957

My image had space in the name, e.g. Pasted image 20221006123035.png, and that was causing a problem from me, and I lost some time fixing it. If someone has the same issue, then here are the steps

  • I uploaded the image via upload option
  • Then clicked on the image in the file browsing UI of the website.
  • The image is opened in the browser. From the browser's URL I copied the url of the image. You can copy the whole path, or relative to your .md file
  • Now insert that link to the .md file like ![overview](Pasted%20image%2020221006123035.png)

Upvotes: -1

Pooja Pathak
Pooja Pathak

Reputation: 9

Create a New issue by clicking on the green button in the upper right corner. Take a screenshot of whatever you need and paste it into the issue message (CMD+V on Mac or CTR+V on Windows).

Upvotes: -1

Indrajeet Gour
Indrajeet Gour

Reputation: 4510

For me, the relative path worked out very well.

How I did this: In my current md file where I wanted to use a picture from another directory, I used a relative path like this - consider following points.

md file loc: base dir -> _post -> current_file.md

& picture file loc which I wanted to use: base dir -> _asset -> picture_to_use.jpeg

What the statement I used was on current_file.md file:

![your-pic-caption-name](../_asset/picture_to_use.jpeg)

Note - before this, I was using direct _asset but Ideally, it so starts from ../_asset/and-so-no

reference - https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes

Upvotes: 4

VonC
VonC

Reputation: 1328742

From March 2021, this is now supported:

Attaching files to markdown files

You can now attach files, including images, to markdown files while you're editing them in the web.

This works just like file attachments in issues and pull requests and supports the same file types.

Just drag and drag, click and select, or paste.

Drop to upload a gif -- https://i1.wp.com/user-images.githubusercontent.com/7900087/109347520-25045d00-7828-11eb-9609-ee96b396eb65.gif?ssl=1

Note: If you add an image to a markdown file, anyone can view the anonymized image URL without authentication, even if the markdown file is in a private repository.
To keep images private, serve them from a private network or server that requires authentication. For more information on anonymized URLs see "About anonymized image URLs".

Upvotes: 16

R Holmes
R Holmes

Reputation: 61

Add ![ScreenShot](screenshot.png) in the readme markdown as mentioned by many above. Replace screenshot.png with the name of the image you uploaded in your repository.

But here is a newbie tip when you upload the image (as I made this mistake myself):

ensure that your image name does not contain spaces. My original image was saved as "Screenshot day month year id.png". If you don't change the name to something like contentofimage.png, it won't appear as an image in your readme file.

Upvotes: 4

diju
diju

Reputation: 667

JUNE 3, 2020 : WORKING ANSWER-

  1. Upload your image to postimage.org
  2. Copy Github-Markdown-Url after uploading Image
  3. Insert in your ReadMe

Upvotes: 55

Jason R Stevens CFA
Jason R Stevens CFA

Reputation: 3121

I googled a few similar questions and did not see any answers with my problem and its quite simple/easy solution.

Google Cloud Storage - a slightly different approach to images in READMEs

Here goes: like the OP, I wanted an image in my Github README, and, knowing the Markdown syntax for doing so, typed it in:

![My Image](https://storage.cloud.google.com/${MY_BUCKET}/${MY_IMAGE}

You need to complete the actual substitutions above (e.g. MY_IMAGE=image.jpg) for this to work.

But, wait...failure--there's no actual rendered photo! And the link is exactly as given by Google Storage!

screenshot of failed Github image upload

Github camo - Anonymous Images

Github hosts your images anonymously, yay! However, this presents an issue for Google storage assets. You need to get the generated url from your Google Cloud Console.

I'm sure there's a smoother way, however, simply visit your given URL endpoint and copy the long URL. Details:

Instructions

  1. Visit your storage console: https://console.cloud.google.com/storage/browser/${MY_BUCKET}?project=${MY_PROJECT}
  2. Click on the image you'd like to display in Github (this brings up the "Object Details" page)
  3. Copy pasta that URL (the one starting with https not gs) into a new browser tab/window
  4. Copy pasta the new generated URL -- it should be longer -- from your new browser tab/window into your Github README file

Hopefully this helps speed up and clarify this issue for anyone else.

Upvotes: 2

Marium Jawed
Marium Jawed

Reputation: 419

Add image in repository from upload file option then in README file

![Alt text]("enter image url of repositoryhere")

Upvotes: 0

Paul
Paul

Reputation: 22005

If you use Markdown (README.md):

Provided that you have the image in your repo, you can use a relative URL: 

![Alt text](/relative/path/to/img.jpg?raw=true "Optional Title")

If you need to embed an image that's hosted elsewhere, you can use a full URL

![Alt text](http://full/path/to/img.jpg "Optional title")

GitHub recommend that you use relative links with the ?raw=true parameter to ensure forked repos point correctly.

The raw=true parameter is there in order to ensure the image you link to, will be rendered as is. That means that only the image will be linked to, not the whole GitHub interface for that respective file. See this comment for more details.

Check out an example: https://raw.github.com/altercation/solarized/master/README.md

If you use SVGs then you'll need to set the sanitize attribute to true as well: ?raw=true&sanitize=true. (Thanks @EliSherer)

Also, the documentation on relative links in README files: https://help.github.com/articles/relative-links-in-readmes

And of course the markdown docs: http://daringfireball.net/projects/markdown/syntax

Additionally, if you create a new branch screenshots to store the images you can avoid them being in the master working tree

You can then embed them using:

![Alt text](/../<branch name>/path/to/image.png?raw=true "Optional Title")

Upvotes: 1024

Zizoh
Zizoh

Reputation: 204

First, create a directory(folder) in the root of your local repo that will contain the screenshots you want added. Let’s call the name of this directory screenshots. Place the images (JPEG, PNG, GIF,` etc) you want to add into this directory.

Android Studio Workspace Screenshot

Secondly, you need to add a link to each image into your README. So, if I have images named 1_ArtistsActivity.png and 2_AlbumsActivity.png in my screenshots directory, I will add their links like so:

 <img src="screenshots/1_ArtistsActivity.png" height="400" alt="Screenshot"/> <img src=“screenshots/2_AlbumsActivity.png" height="400" alt="Screenshot"/>

If you want each screenshot on a separate line, write their links on separate lines. However, it’s better if you write all the links in one line, separated by space only. It might actually not look too good but by doing so GitHub automatically arranges them for you.

Finally, commit your changes and push it!

Upvotes: 1

Dan Alboteanu
Dan Alboteanu

Reputation: 10252

add this to README

<div align="center">
    <img src="/screenshots/screen1.jpg" width="400px"</img> 
</div>

Upvotes: 15

Taymour Niazi
Taymour Niazi

Reputation: 181

Much simpler than adding URL Just upload an image to the same repository, like:

![Screenshot](screenshot.png)

Upvotes: 16

Shaurya Uppal
Shaurya Uppal

Reputation: 3700

Method 1->Markdown way

![Alt Text](https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH})

Method 2->HTML way

<img src="https://link(format same as above)" width="100" height="100"/>

or

<img src="https://link" style=" width:100px ; height:100px " />

Note-> If you don't want to style your image i.e resize remove the style part

Upvotes: 8

Asifur Rahman
Asifur Rahman

Reputation: 17

To me the best way is -

  1. Create an new issue with that repository on github and then upload the file in gif format.To convert video files into gif format you can use this website http://www.online-convert.com/
  2. Submit the newly created issue.
  3. Copy the address of the uploaded file
  4. Finally in your README file put ![demo](COPIED ADDRESS)

Hope this will help .

Upvotes: 0

edelans
edelans

Reputation: 9088

The markdown syntax for displaying images is indeed:

![image](https://{url})

BUT: How to provide the url ?

  • You probably do not want to clutter your repo with screenshots, they have nothing to do with code
  • you might not want either to deal with the hassle of making your image available on the web... (upload it to a server... ).

So... you can use this awesome trick to make github host your image file. TDLR:

  1. create an issue on the issue list of your repo
  2. drag and drop your screenshot on this issue
  3. copy the markdown code that github has just created for you to display your image
  4. paste it on your readme (or wherever you want)

http://solutionoptimist.com/2013/12/28/awesome-github-tricks/

Upvotes: 18

Mick Cullen
Mick Cullen

Reputation: 9464

With the images located in /screen-shots directory. The outer <div> allows the images to be positioned. Padding is achieved using <img width="desired-padding" height="0">.

<div align="center">
        <img width="45%" src="screen-shots/about.PNG" alt="About screen" title="About screen"</img>
        <img height="0" width="8px">
        <img width="45%" src="screen-shots/list.PNG" alt="List screen" title="List screen"></img>
</div>

Upvotes: -5

mmcorrelo
mmcorrelo

Reputation: 1014

One line below should be what you looking for

if your file is in repository 

![ScreenShot](https://raw.github.com/{username}/{repository}/{branch}/{path})

if your file is in other external url

![ScreenShot](https://{url})

Upvotes: 26

Ryan
Ryan

Reputation: 5496

I found that the path to the image in my repo did not suffice, I had to link to the image on the raw.github.com subdomain.

URL format https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}

Markdown example ![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)

Upvotes: 57

Related Questions