How to embed images in GitHub Readme Files

- by

In this screencast I’ll show you how to add images to your GitHub Readme files. You can use the Markdown or HTML syntax for this, I’ll show you both versions. Make sure to upload images to your own repository and provide the relative path to them.

Here’s the syntax:

In Markdown

In Markdown syntax, use the following example to embed an image:



GitHub also supported the HTML syntax, which uses the standard IMG tag. Pasting HTML code in a website is always a little tricky, but let me try:

<img src="/path/to/image.png">

view raw
hosted with ❤ by GitHub

Should you have spaces in your file names, you can replace them with %20, just like in standard HTML (like “file%20name”).

Now go and make those files look handsome!

If you enjoy my content, please consider supporting me on Ko-fi. In return you can browse this whole site witout any pesky ads! More details here.

Add your voice!

This site uses Akismet to reduce spam. Learn how your comment data is processed.