Recently I joined GitHub. I hosted some projects there.

I need to include some images in my README File. I don't know how to do that.

I searched about this, but all I got was some links which tell me to "host images on web and specify the image path in README.md file".

Is there any way to do this without hosting the images on any third-party web hosting services?

captainclam

Try this markdown:

![alt text](http://url/to/img.png)

I think you can link directly to the raw version of an image if it's stored in your repository. i.e.

![alt text](https://raw.githubusercontent.com/username/projectname/branch/path/to/img.png)

Edit: just noticed comment linking to article which suggests using gh-pages. Also, relative links can be a better idea than the absolute URLs I posted above.

resultsway

You can also use relative paths like

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

Ahmad Ajmi

You can create a New Issue
upload(drag & drop) images to it
Copy the images URL and paste it into your README.md file.

here is a detailed youTube video explained this in detail:

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

It's much simpler than that.

Just upload your image to the repository root, and link to the filename without any path, like so:

![Screenshot](screenshot.png)

Evin1_

You can also add images with simple HTML tags:

<p align="center">   <img src="your_relative_path_here" width="350" title="hover text">   <img src="your_relative_path_here_number_2_large_name" width="350" alt="accessibility text"> </p>

Many of the posted solutions are incomplete or not to my taste.

An external CDN like imgur adds another tool to the chain. Meh.
Creating a dummy issue in the issue tracker is a hack. It creates clutter and confuses users. It's a pain to migrate this solution to a fork, or off GitHub.
Using the gh-pages branch makes the URLs brittle. Another person working on the project maintaining the gh-page may not know something external depends on the path to these images. The gh-pages branch has a particular behavior on GitHub which is not necessary for hosting CDN images.
Tracking assets in version control is a good thing. As a project grows and changes it's a more sustainable way to manage and track changes by multiple users.
If an image applies to a specific revision of the software, it may be preferable to link an immutable image. That way, if the image is later updated to reflect changes to the software, anyone reading that revision's readme will find the correct image.

My preferred solution, inspired by this gist, is to use an assets branch with permalinks to specific revisions.

git checkout --orphan assets git reset --hard cp /path/to/cat.png . git add . git commit -m 'Added cat picture' git push -u origin assets git rev-parse HEAD  # Print the SHA, which is needed below.

Construct a "permalink" to this revision of the image, and wrap it in Markdown:

![Cat](https://raw.githubusercontent.com/{user}/{repo}/{sha}/cat.png)

e.g.

![Cat](https://raw.githubusercontent.com/paulmelnikow/zsh-startup-timer/3923c60fc66d4223ccf063d169ccf2ff167b1270/cat.png)

To always show the latest image on the assets branch, use assets in place of the sha:

![Cat](https://raw.githubusercontent.com/{user}/{repo}/assets/cat.png)

Commit your image (image.png) in a folder (myFolder) and add the following line in your README.md:

![Optional Text](../master/myFolder/image.png)

Create an issue regarding adding images
Add the image by drag and drop or by file chooser
Then copy image source
Now add ![alt tag](http://url/to/img.png) to your README.md file

Done!

Alternatively you can use some image hosting site like imgur and get it's url and add it in your README.md file or you can use some static file hosting too.

Sample issue

Basic Syntax

![myimage-alt-tag](url-to-image)

Here:

my-image-alt-tag : text that will be displayed if image is not shown.
url-to-image : whatever your image resource is. URI of the image

Example:

![stack Overflow](http://lmsotfy.com/so.png)

This will look like the following:

Just add an <img> tag to your README.md with relative src to your repository. If you're not using relative src, make sure the server supports CORS.

It works because GitHub support inline-html

<img src="/docs/logo.png" alt="My cool logo"/> # My cool project and above is the logo of it

Observe here

I need to include some images in my README File. I don't know how to do that.

I created a small wizard that allows you to create and customize simple image galleries for your GitHub repository's readme: See ReadmeGalleryCreatorForGitHub.

The wizard takes advantage of the fact that GitHub allows img tags to occur in the README.md. Also, the wizard makes use of the popular trick of uploading images to GitHub by drag'n'dropping them in the issue area (as already mentioned in one of the answers in this thread).

In my case i use imgur and use the direct link this way.

![img](http://i.imgur.com/yourfilename.png)

I usually host the image on the site, this can link to any hosted image. Just toss this in the readme. Works for .rst files, not sure about .md

.. image:: https://url/path/to/image    :height: 100px    :width: 200 px    :scale: 50 %

I have solved this problem. You only need to refer to someone else's readme file.

At first,you should upload an image file to github code library ! Then direct reference to the address of the image file .

You can link to images in your project from README.md (or externally) using the alternative github CDN link.

The URL will look like this:

https://cdn.rawgit.com/<USER>/<REPO>/<BRANCH>/<PATH>/<TO>/<FILE>

I have an SVG image in my project, and when I reference it in my Python project documentation, it does not render.

Project link

Here is the project link to the file (does not render as an image):

https://github.com/jongracecox/anybadge/blob/master/examples/awesomeness.svg

Example embedded image:

Raw link

Here is the RAW link to the file (still does not render as an image):

https://raw.githubusercontent.com/jongracecox/anybadge/master/examples/awesomeness.svg

Example embedded image:

CDN link

Using the CDN link, I can link to the file using (renders as an image):

https://cdn.rawgit.com/jongracecox/anybadge/master/examples/awesomeness.svg

Example embedded image:

This is how I am able to use images from my project in both my README.md file, and in my PyPi project reStructredText doucmentation (here)

You can just do:

git checkout --orphan assets cp /where/image/currently/located/on/machine/diagram.png . git add . git commit -m 'Added diagram' git push -u origin assets

Then you can just reference it in the README file like so:

![diagram](diagram.png)

Use tables to stand out, it will give separate charm to it

Table Syntax is:

Separate each column cell by symbol |

and table header (First row) by 2nd row by ---

| col 1 | col 2 |
|------------|-------------|
| image 1 | image 2 |

output

Now just put <img src="url/relativePath"> at image 1 and image 2 if you are using two images

Note: if using multiple images just include more columns, may use width and height attribute to make it look readable

Example

| col 1 | col 2 |
|------------|-------------|
| <img src="https://media.wired.com/photos/5926db217034dc5f91becd6b/master/w_582,c_limit/so-logo-s.jpg" width="250"> | <img src="https://mk0jobadderjftub56m0.kinstacdn.com/wp-content/uploads/stackoverflow.com-300.jpg" width="250"> |

Spacing dose not matter

Output image

helped by : adam-p

In my case I wanted to show a print screen on Github but also on NPM. Even though using the relative path was working within Github, it wasn't working outside of it. Basically, even if I pushed my project to NPM as well (which simply uses the same readme.md, the image was never showing.

I tried a few ways, at the end this is what worked for me:

![Preview](https://raw.githubusercontent.com/username/project/master/image-path/image.png)

I now see my image correctly on NPM or anywhere else that I could publish my package.

In case you need to upload some pictures for documentation, a nice approach is to use git-lfs. Asuming that you have installed the git-lfs follow these steps:

Intialize git lfs for your each image type:

git lfs *.png git lfs *.svg git lfs *.gif git lfs *.jpg git lfs *.jpeg

Create a folder that will be used as image location eg. doc. On GNU/Linux and Unix based systems this can be done via:
```
cd project_folder mkdir doc git add doc 
```
Copy paste any images into doc folder. Afterwards add them via git add command.
Commit and push.
The images are publicly available in the following url:

https://media.githubusercontent.com/media/^github_username^/^repo^/^branch^/^image_location in the repo^

Where: * ^github_username^ is the username in github (you can find it in the profile page) * ^repo_name^ is the repository name * ^branch^ is the repository branch where the image is uploaded * ^image_location in the repo^ is the location including the folder that the image is stored.

Also you can upload the image first then visit the location in your projects github page and navigate through until you find the image then press the download button and then copy-paste the url from the browser's address bar.

Look this from my project as reference.

Then you can use the url to include them using the markdown syntax mentioned above:

![some alternate text that describes the image](^github generated url from git lfs^)

Eg: Let us suppose we use this photo Then you can use the markdown syntax:

![In what order to compile the files](https://media.githubusercontent.com/media/pc-magas/myFirstEnclave/master/doc/SGX%20Compile%20workflow.png)

JUST THIS WORKS!!

take care about your file name uppercase in tag and put PNG file inroot, and link to the filename without any path:

![Screenshot](screenshot.png)

I am just extending or adding an example to the already accepted answer.

Once you have put the image on your Github repo.

Then:

Open the corresponding Github repo on your browser.
Navigate to the target image file Then just open the image in a new tab.
Copy the url
And finally insert the url to the following pattern ![alt text](https://raw.githubusercontent.com/username/projectname/branch/path/to/img.png)

On my case it is

![In a single picture](https://raw.githubusercontent.com/shadmazumder/Xcode/master/InOnePicture.png)

Where

shadmazumder is my username
Xcode is the projectname
master is the branch
InOnePicture.png is the image, On my case InOnePicture.png is in the root directory.

This Answer can also be found at: https://github.com/YourUserAccount/YourProject/blob/master/DirectoryPath/ReadMe.md

Display images from repo using:

prepend domain: https://raw.githubusercontent.com/ or https://cdn.rawgit.com/

append flag: `?sanitize=true&raw=true`

use `<img />` tag

Eample url works for svg, png, and jpg using:

Domain: raw.githubusercontent.com/
UserName: YourUserAccount/
Repo: YourProject/
Branch: YourBranch/
Path: DirectoryPath/
Filename: example.png

Works for SVG, PNG, and JPEG

 - `raw.githubusercontent.com/YourUserAccount/YourProject/YourBranch/DirectoryPath/svgdemo1.svg?sanitize=true&raw=true`

Working example code displayed below after used:

**raw.githubusercontent.com**: <img src="https://raw.githubusercontent.com/YourUserAccount/YourProject/master/DirectoryPath/Example.png?sanitize=true&raw=true" />  <img src="https://raw.githubusercontent.com/YourUserAccount/YourProject/master/DirectoryPath/svgdemo1.svg?sanitize=true&raw=true" />  **https://cdn.rawgit.com**: <img src="https://cdn.rawgit.com/YourUserAccount/YourProject/master/DirectoryPath/Example.png" />  <img src="https://cdn.rawgit.com/YourUserAccount/YourProject/master/DirectoryPath/svgdemo1.svg" />

raw.githubusercontent.com:

https://cdn.rawgit.com:

Thanks: - https://stackoverflow.com/a/48723190/1815624 - https://github.com/potherca-blog/StackOverflow/edit/master/question.13808020.include-an-svg-hosted-on-github-in-markdown/readme.md

LATEST

Wikis can display PNG, JPEG, or GIF images

Now you can use:

[[https://github.com/username/repository/blob/master/img/octocat.png|alt=octocat]]

-OR-

Follow these steps:

On GitHub, navigate to the main page of the repository.
Under your repository name, click Wiki.
Using the wiki sidebar, navigate to the page you want to change, and then click Edit.
On the wiki toolbar, click Image.
In the "Insert Image" dialog box, type the image URL and the alt text (which is used by search engines and screen readers).
Click OK.

Refer Docs.

There are 2 simple way you can do this ,

1) use HTML img tag ,

2) ![](the path where your image is saved/image-name.png)

the path would you can copy from the URL in the browser while you have opened that image. there might be an issue occur of spacing so make sure if there is any space b/w two words of path or in image name add-> %20. just like browser do.

Both of them will work , if you want to understand more you can check my github -> https://github.com/adityarawat29

I have found another solution but quite different and i'll explain it

Basically, i used the tag to show the image, but i wanted to go to another page when the image was clicked and here is how i did it.

<a href="the-url-you-want-to-go-when-image-is-clicked.com" /> <img src="image-source-url-location.com" />

If you put it right next to each other, separated by a new line, i guess when you click the image, it goes to the tag wich has the href to the other site you want to redirect.

We can do this simply,

create a New Issue on GitHub
drag and drop images on the body div of Issue

after a few seconds, a link will be generated. Now, copy the link or image URL and use it any supported platform.

Consider using a table if adding multiple screenshots and want to align them using tabular data for improved accessibility as shown here:

If your markdown parser supports it you could also add the role="presentation" WIA-ARIA attribute to the TABLE element and omit the th tags.

I wanted to update this using ZenHub, since GitHub and ZenHub have changed their graphical layouts.

If you install ZenHub and allow access to your GitHub, then you can navigate to the ZenHub tab once in your repo and open a new issue.

This is an updated version of Ahmad Amji's YouTube video posting.

Step 1:

Step 2: From there you can open an attachment.

Step 3: And then from there you can use the link generated automatically. This way you don't have to bother with creating a new repo just for images.

Then use the standard MarkDown syntax with the URL provided.

Step 4

![alt text](image URL from ZenHub issue)

Step 5 Don't forget to close the issue draft and not actually submit it. The image URL should still work properly!

来源：https://stackoverflow.com/questions/14494747/add-images-to-readme-md-on-github

标签

git

github

Markdown

github-flavored-markdown

readme

Add images to README.md on GitHub

It's much simpler than that.

Basic Syntax

Here:

Example:

This will look like the following:

Project link

Raw link

CDN link

Display images from repo using:

prepend domain: https://raw.githubusercontent.com/ or https://cdn.rawgit.com/

append flag: ?sanitize=true&raw=true

use <img /> tag

LATEST

append flag: `?sanitize=true&raw=true`

use `<img />` tag