How to add images to README.md on GitHub?

github markdown github-flavored-markdown readme
Midhun MP picture Midhun MP · Jan 24, 2013 · Viewed 1M times · Source

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?

Answer

captainclam picture captainclam · Jan 24, 2013

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)

Related questions

GitHub relative link in Markdown file

Is there a way to create a URL anchor, <a>, link from within a Markdown file, to another file within the same repository and branch (aka a link relative to the current branch)? For example, in the master …

Read More
How can I test what my readme.md file will look like before committing to github?

I am writing a readme for my github project in the .md format. Is there a way can I test what my readme.md file will look like before committing to github?

Read More
Is there a command line utility for rendering GitHub flavored Markdown?

I'm wondering if there is a command line utility for taking a GitHub flavored Markdown file and rendering it to HTML. I'm using a GitHub wiki to create website content. I've cloned the repository on my server and would then …

Read More