Help
cancel
Showing results for 
Search instead for 
Did you mean: 
Pilot Lvl 1
Message 1 of 16

How do you put Images on the README.md file?

Solved! Go to Solution.

I was asking because I see a lot of repositories and tried doing the same thing but couldn't figure out how to do it

15 Replies
Solution
Community Manager
Message 2 of 16

Re: How do you put Images on the README.md file?

Hi @SHADOWELITE7,

 

README.md files are created using Markdown which you can use to format text and add images. The GitHub Guide for Mastering Markdown has some helpful hints that can get you started with this.

 

Thanks!

Pilot Lvl 1
Message 3 of 16

Re: How do you put Images on the README.md file?

thx


wrote:

Hi @SHADOWELITE7,

 

README.md files are created using Markdown which you can use to format text and add images. The GitHub Guide for Mastering Markdown has some helpful hints that can get you started with this.

 

Thanks!


 

Commander Lvl 3
Message 4 of 16

Re: How do you put Images on the README.md file?

![Image description](link-to-image)


- Mark
Pilot Lvl 1
Message 5 of 16

Re: How do you put Images on the README.md file?

thx


wrote:

![Image description](link-to-image)


 

Ground Controller Lvl 1
Message 6 of 16

Re: How do you put Images on the README.md file?

This did the trick nicely! Upload the file to the same directory and just use this to inludie it within the readme. Thanks a lot, this saved me a lot of searching around for a solution.

Copilot Lvl 2
Message 7 of 16

Re: How do you put Images on the README.md file?

Does this still work?  Because I'm trying the same thing, then navigating to the github page, and all I see are broken image icons, even though some display fine locally.  I expected "Test Image 1" to work when the file 3DTest.png is uploaded into the same directory.

 

![Test Image 1](3DTest.png)

![Test Image 2]("3DTest.png")

![Test Image 3](/3DTest.png)

![Test Image 4](https://github.com/tograh/testrepository/3DTest.png)

![Test Image 5](https://.../3DTest.png)

![Test Image 6](master/3DTest.png)

![Test Image 7](https://github.com/tograh/testrepository/master/3DTest.png)

![Test Image 8](https://raw.githubusercontent.com/tograh/testrepository/master/3DTest.png)

Moderator
Message 8 of 16

Re: How do you put Images on the README.md file?

Hi @tograh,

 

For the images to work properly, you have to include the full image URL. That said, if none of your images are working, I'd be curious to see the repo in which they are located, if possible. Are you doing this work in a public repo? If so, can you provide a link so I/we can take a closer look?

Mark helpful posts with Accept as Solution to help other users locate important info. Don't forget to give Kudos for great content!

Copilot Lvl 2
Message 9 of 16

Re: How do you put Images on the README.md file?

Thank you for the reply, Nadia.  We've been looking into the problem, and it seems to be limited to inside our corporate network.  Outside, we see the markup displaying as expected.

 

I should have updated sooner!  Many thanks.

Ground Controller Lvl 1
Message 10 of 16

Re: How do you put Images on the README.md file?

OK i give up. how do you know the full path?

 

tried both of these. my images are in the top level folder

 

<img src="https://github.com/KrisKasprzak/ILI9341_t3_controls">
![Equalizer](https://github.com/KrisKasprzak/ILI9341_t3_controls/Equalizer.bmp)