How do I center an image in the README.md file on GitHub?

I’ve been looking at the Markdown syntax used in GitHub […], I can’t figure out how to center an image

TL;DR

No, you can’t by only relying on Markdown syntax. Markdown doesn’t care about positioning.

Note: Some Markdown processors support inclusion of HTML (as rightfully pointed out by @waldyr.ar), and in the GitHub case you may fallback to something like <div style="text-align:center"><img src="..." /></div>.

Beware that there’s no guarantee the image will be centered if your repository is forked in a different hosting environment (CodePlex, Bitbucket, etc.) or if the document isn’t read through a browser (Sublime Text Markdown preview, MarkdownPad, Visual Studio Web Essentials Markdown preview, …).

Note 2: Keep in mind that even within the GitHub website, the way Markdown is rendered is not uniform. The wiki, for instance, won’t allow such CSS positional trickery.

Unabridged version

The Markdown syntax doesn’t provide one with the ability to control the position of an image.

In fact, it would be borderline against the Markdown philosophy to allow such formatting, as stated in the Philosophy section.

“A Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. “

Markdown files are rendered by github.com website through the use of the Ruby Redcarpet library.

Redcarpet exposes some extensions (such as strikethrough, for instance) which are not part of standard Markdown syntax and provide additional “features”. However, no supported extension allow you to center an image.

Leave a Comment