Skip to content

Instantly share code, notes, and snippets.

@DavidWells
Last active October 9, 2024 10:37
Show Gist options
  • Save DavidWells/7d2e0e1bc78f4ac59a123ddf8b74932d to your computer and use it in GitHub Desktop.
Save DavidWells/7d2e0e1bc78f4ac59a123ddf8b74932d to your computer and use it in GitHub Desktop.
Guide to aligning images in github readme.md files. https://davidwells.io/snippets/how-to-align-images-in-markdown

Aligning images

This is a guide for aligning images.

See the full Advanced Markdown doc for more tips and tricks

left alignment

This is the code you need to align images to the left:

<img align="left" width="100" height="100" src="https://picsum.photos/100/100">

right alignment

This is the code you need to align images to the right:

<img align="right" width="100" height="100" src="https://picsum.photos/100/100">

center alignment example

<p align="center">
  <img width="460" height="300" src="https://picsum.photos/460/300">
</p>

Markdown Formatting on steriods

If you like this, you might enjoy markdown-magic. I built it to automatically format markdown files and allow folks to sync docs/code/data from external sources.

@vishwac09
Copy link

Thanks a lot

@eddyjav
Copy link

eddyjav commented Jan 4, 2023

Thanks a lot 🔥

@rockysushant
Copy link

How to draw a line in readme file?

@Reelix
Copy link

Reelix commented Apr 12, 2023

How to draw a line in readme file?

3 dashes

---

@rockysushant
Copy link

and how to put spaces between two images vertically?

@rockysushant
Copy link

and how to put spaces between two images vertically?

@RitamChakraborty
Copy link

RitamChakraborty commented Apr 13, 2023

and how to put spaces between two images vertically?

No Gap

<p>
    <img src="https://picsum.photos/100/100" >
    <img src="https://picsum.photos/100/100" >
</p>


Horizontal Gap

With hspace property you can set horizontal (left and right) padding for an image

<p>
    <img src="https://picsum.photos/100/100" hspace="10" >
    <img src="https://picsum.photos/100/100" hspace="10" >
</p>


Vertical Gap

We also have a property "vspace", which does what it sounds like, add vertical spacing. But it doesn't seem to work on GitHub, unlike VSCode's buit in markdown viewer. So probably just add a <p> tag in between.

<p>
    <img src="https://picsum.photos/500/100" >
    <p>
    <img src="https://picsum.photos/500/100" >
    <p>
    <img src="https://picsum.photos/500/100" >
</p>

@ihsanunot
Copy link

Thank you very much, this so helped me a lot :)

@timmy-cde
Copy link

is it possible to overlap 2 images?

@ivanglushko
Copy link

after aligning with "center" it renders the content below as centered :(

@ivanglushko
Copy link

ivanglushko commented May 12, 2023

after aligning with "center" it renders the content below as centered :(

Fixed it instead of <div> you should use <p> and put your images in there this way it doesnt center the rest of the content.
Screenshot 2023-05-12 at 13 02 40

And tip for bordering like in the pic above you can use <kbd></kbd> tag wrap your <p> or <img> in it

@AuracleTech
Copy link

Stopped working

@Ringoshere
Copy link

When I move it to the left or right, the text below gets put up alongside the image. How can I avoid that happening? I tried multiple
but no luck.
This is the format I need...
Screenshot 2023-08-18 at 10 46 48 AM

@RitamChakraborty
Copy link

When I move it to the left or right, the text below gets put up alongside the image. How can I avoid that happening? I tried multiple but no luck.

You can try something like this

<img align="right" src="https://picsum.photos/300/200" alt="image" />
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five 
centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.



image

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.

@bad1dea
Copy link

bad1dea commented Nov 28, 2023

Is there any way to have multiple images vertical on left.. and a code block on right side? Every time I try, the code block starts at the last image...

image

@RitamChakraborty
Copy link

Try this...

<img align="right" src="https://picsum.photos/700/480" alt="image" />
<img src="https://picsum.photos/150/100" alt="image" />
<img src="https://picsum.photos/150/100" alt="image" />
<img src="https://picsum.photos/150/100" alt="image" />
<img src="https://picsum.photos/150/100" alt="image" />

image

image

image

image

image

@ruizlenato
Copy link

image
does anyone have any idea how I can fix this? the Heading line crosses over the image

@cyb3rko
Copy link

cyb3rko commented Mar 20, 2024

@ruizlenato I have seen the same issue in many different repositories now.
Seems like GitHub changed something about the Markdown rendering.

@RitamChakraborty
Copy link

Can this not be fixed with few line breaks? (<br>)


Twittergram

Twittergram

Twittergram is a bot for telegram written in golang using the telego library with localization support (i18n) and some twitter-related functions, such as downloading media and sending it to telegram.

See more at @twittergramrobot or @xgramrobot



Donate — Help keep the project alive and up-to-date.

Donate with Ko-Fi

Licensed under the terms of the GNU General Public License v3 (GPLv3)

@brandonsturgeon
Copy link

Having trouble aligning a small image vertically with my text:

Library Name0/30Easy

Example content

<details>
<summary><a href="https://whatever.com"><code>Library Name</code></a> • <strong><code>0/30</code></strong> • <img alt="Easy" src="https://img.shields.io/badge/Easy-32CD32"></summary>

Example content
</details>

align="middle" does have an effect, but not quite the one I intended...

Library Name0/30Easy

Example content

Making the image smaller seems to make it align better, but then it's too small:

Library Name0/30Easy

Example content

Any advice?

@RitamChakraborty
Copy link

Use align="center"

<details>
    <summary>
        <a href="https://whatever.com"><code>Library Name</code></a>
        <span></span>
        <strong><code>0/30</code></strong>
        <span></span>
        <img align="center" alt="Easy" src="https://img.shields.io/badge/Easy-32CD32">
    </summary>
    Example content
</details>
Library Name 0/30 Easy Example content

@brandonsturgeon
Copy link

I was confused because your post had the same issue as mine, but then I checked on Chrome and it looked good!

half-win; thank you 👍

@yvele
Copy link

yvele commented Sep 11, 2024

Looks to be not working anymore 🤔

image

@azat-io
Copy link

azat-io commented Sep 11, 2024

The same problem. It not woking anymore

@mkingvc
Copy link

mkingvc commented Sep 11, 2024

Same here. Looks like GitHub changed something recently.

@azat-io
Copy link

azat-io commented Sep 11, 2024

Looks like it was fixed

@rahaaatul
Copy link

is there a way to add rounded border outside images?

@bishos123
Copy link

Thanks guys!

@danielvartan
Copy link

👏👏👏

@Sofia-A-Fayo-Freites
Copy link

Thank you. Just what i needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment