githubmarkdowngithub-flavored-markdownreadme

How to add images to README.md on GitHub?

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?

Solution

  • 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://github.com/[username]/[reponame]/blob/[branch]/image.jpg?raw=true)