Images, Badges & Avatars in Markdown Tables
Adding visual assets—such as Shields.io build badges, technology logos, contributor grids, and UI preview screenshots—transforms plain Markdown documentation into high-impact, professional presentations. Because Markdown table cells permit both inline Markdown image syntax and raw HTML5 <img> tags, you have complete control over styling, sizing, and hyperlink wrapping.
Quick Reference: Embedding Assets
| Asset Type | Syntax Structure | Primary Benefit |
|---|---|---|
| Standard Image |  | Pure Markdown, lightweight, works everywhere |
| Clickable Badge | [](target-url) | Turns npm/CI badges into clickable destinations |
| Pixel-Sized Image | <img src="logo.png" width="32"> | Prevents high-res images from breaking table width |
| Circular Avatar | <img src="u.png" width="40" style="border-radius:50%"> | Renders round profile pictures for team/sponsor grids |
Embedding Images & Centering Columns
To embed an image inside a table cell using pure Markdown, insert the standard  tag directly between cell pipes. Because badge and logo icons look best when centered horizontally, pair the image column with :--: in the delimiter row:
| Platform | Logo | Type | Supported | | :------- | :--: | :--- | :-------: | | React |  | Frontend Library | ✅ | | Next.js |  | Full-Stack Framework | ✅ | | Node.js |  | Runtime Engine | ✅ |
Clickable Linked Badges ([](url))
In software repositories, status badges should not just be static pictures; clicking them should take the developer to the live CI pipeline, the npm package registry, or the code coverage dashboard. To achieve this, wrap the image tag inside standard link brackets:
| Package | Version | CI Pipeline | License | | :------ | :-----: | :---------: | :-----: | | `markdowntables` | [](https://www.npmjs.com) | [](https://github.com) | [](https://opensource.org) |
💡 Notice the syntax hierarchy: [](TARGET_URL).
Image Sizing & Preventing Column Blowout
Standard Markdown has no syntax for specifying image dimensions. If you embed a high-resolution 1920x1080 screenshot or 512x512 logo using , the browser will render it at full physical resolution, causing the table column to stretch across the screen and breaking layout readability. Use HTML <img> tags with explicit width attributes to maintain uniform cell sizing:
| Theme Mode | Preview Screenshot | Width Rule | | :--------- | :-----------------: | :--------- | | Dark Mode | <img src="https://markdowntables.com/og-image.png" width="200" alt="Dark Preview"> | Constrained to 200px | | Light Mode | <img src="https://markdowntables.com/og-image.png" width="200" alt="Light Preview"> | Constrained to 200px |
Contributor Grids & Circular Avatars
Creating a team showcase or sponsor wall in your GitHub repository README is straightforward using circular avatars and centered columns. GitHub provides dynamic user avatars at https://github.com/USERNAME.png?size=80:
| Contributor | Profile | Role | Status | | :---------: | :------ | :--- | :----: | | <img src="https://github.com/torvalds.png?size=80" width="48" style="border-radius:50%"> | [Linus Torvalds](https://github.com/torvalds) | Linux Architect | 👑 Core | | <img src="https://github.com/gaearon.png?size=80" width="48" style="border-radius:50%"> | [Dan Abramov](https://github.com/gaearon) | React Core Alum | 🚀 Author |Rendered Browser Simulation
| Contributor | Profile | Role | Status |
|---|---|---|---|
LT | Linus Torvalds | Linux Architect | 👑 Core |
DA | Dan Abramov | React Core Alum | 🚀 Author |
Common Pitfalls & Broken vs Fixed Examples
Pitfall 1: Unescaped Pipe Character Inside Shields.io Badge URL
Pitfall 2: Forgetting the Exclamation Mark
Platform Compatibility Matrix
| Environment | Support Mode | Notes & Limitations |
|---|---|---|
| GitHub (GFM) | Full Support | Supports Markdown images, HTML <img>, clickable badges, Camo proxy caching, and dark mode URL fragments. |
| GitLab (GLFM) | Full Support | Native rendering for badges and images; allows HTML <img> tags with width and height. |
| Obsidian | Full Support | Renders local internal vault attachments (![[image.png|100]]) and remote URLs. |
| Notion | Partial Support | Markdown import renders static images; database tables require URL or Files & Media columns. |
| Pandoc | Full Support | Translates embedded images into \includegraphics in PDF/LaTeX and native media in DOCX. |
| VS Code | Full Support | Markdown preview resolves both local relative workspace paths and remote HTTPS images. |
Frequently Asked Questions
How do I prevent large images from blowing out my Markdown table column width?
Standard Markdown image syntax () renders at native image resolution, which can stretch columns across thousands of pixels. To constrain image dimensions, replace standard markdown with an HTML <img> tag with an explicit width attribute: <img src="screenshot.png" width="240" alt="Preview">.
Why does my Shields.io badge break my Markdown table row?
Shields.io parameters or custom label text often contain pipe characters ("|") or double dashes. Because the pipe character is the column separator in Markdown, unescaped pipes split the cell into extra invalid columns. To fix this, encode the pipe character in the URL as %7C or escape it with a backslash if it appears in plain text.
Can I put multiple badges side by side in a single table cell?
Yes. Simply place multiple image tags or linked badge tags separated by a single space inside the same cell pipes: | [](link1) [](link2) |. They will render inline side-by-side.
Does GitHub support SVG images and logos inside Markdown tables?
Yes. GitHub supports SVGs hosted over HTTPS or within your repository. However, for security, GitHub sanitizes SVGs by stripping embedded JavaScript and foreign objects through its Camo proxy.
How do I display different images for Light Mode and Dark Mode in GitHub tables?
GitHub supports theme-aware images by appending `#gh-dark-mode-only` or `#gh-light-mode-only` to the image fragment URL: <img src="logo-white.png#gh-dark-mode-only" width="32"><img src="logo-dark.png#gh-light-mode-only" width="32">. GitHub automatically hides the non-matching theme image.
Related Markdown Table Syntax Guides
Prevent badge URLs from breaking columns.
Column Width ControlControl wrapping, image overflow, and sizing.
GitHub README TablesMaster sponsor walls and README layouts.
Build GitHub-Ready README Tables
Read our comprehensive GitHub README guide for advanced sponsor tables, feature matrices, and dark mode tips.