How to Use the Mentioned in Awesome Badge for Your Project

Add the "Mentioned in Awesome" badge to your open source project by embedding the markdown image snippet from https://awesome.re, replacing the placeholder text with the name and URL of the specific awesome list that features your project.

The "Mentioned in Awesome" badge is a readonly image that projects display to indicate they have been curated in an awesome list. According to the sindresorhus/awesome source code, this badge is specifically intended for projects listed inside awesome repositories, not for the awesome lists themselves. Adding this badge to your README provides immediate social proof that your project has been recognized by the awesome community.

What Is the Mentioned in Awesome Badge?

The badge serves as a visual indicator that your project appears in a curated awesome list, such as Awesome Node.js or Awesome Python. As documented in awesome.md (lines 31‑49), the badge is not for the awesome lists themselves, but rather for the individual projects featured within those lists.

The badge images are static SVG files that you link to remotely rather than host yourself. They are served through the CDN at https://awesome.re/, which forwards to the assets stored in the repository.

Badge Styles and Image Sources

The sindresorhus/awesome repository provides two visual styles for the badge. Both versions are stored in the media/ directory and served via the awesome.re CDN.

Regular Style

The standard badge uses the file media/mentioned-badge.svg in the repository root. Access it via:

https://awesome.re/mentioned-badge.svg

Flat Style

For a flattened design aesthetic, use media/mentioned-badge-flat.svg:

https://awesome.re/mentioned-badge-flat.svg

How to Add the Badge to Your README

Follow these steps to implement the badge correctly in your project documentation:

1. Select your preferred style (regular or flat) based on your README's visual design.
2. Copy the markdown template from the examples below.
3. Replace the placeholders with the actual name of the awesome list (e.g., "Node.js") and the full URL to that list's repository.
4. Insert the completed snippet near the top of your README, typically alongside other status badges.
5. Do not modify the image URLs – they must remain exactly as https://awesome.re/mentioned-badge.svg or https://awesome.re/mentioned-badge-flat.svg.

Markdown Syntax Examples

Basic Regular Style

Use this snippet for the standard badge appearance:

[![Mentioned in Awesome Node.js](https://awesome.re/mentioned-badge.svg)](https://github.com/sindresorhus/awesome-nodejs)

Flat Style Alternative

For the flat design variant:

[![Mentioned in Awesome Node.js](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/sindresorhus/awesome-nodejs)

Template with Placeholders

Copy this template and replace the placeholder text:

[![Mentioned in Awesome <LIST_NAME>](https://awesome.re/mentioned-badge.svg)](https://github.com/<LIST_OWNER>/<LIST_REPO>)

Real-World Example

Here is the complete markdown for a project listed in Awesome Node.js:

[![Mentioned in Awesome Node.js](https://awesome.re/mentioned-badge.svg)](https://github.com/sindresorhus/awesome-nodejs)

Summary

• The "Mentioned in Awesome" badge is designed for projects listed within awesome lists, not for the curators of those lists.
• Choose between regular (mentioned-badge.svg) and flat (mentioned-badge-flat.svg) styles hosted on https://awesome.re/.
• Reference the official documentation in awesome.md (lines 31‑49) for usage guidelines.
• Replace the placeholder text in the markdown template with your specific awesome list name and URL.
• Do not edit or self-host the badge image files; link directly to the CDN URLs.

Frequently Asked Questions

Who can use the mentioned in awesome badge?

Only projects that actually appear in a curated awesome list should display this badge. The guidelines in awesome.md specify that it is a readonly indicator for featured projects, not a general decoration or a label for the awesome repositories themselves.

Can I modify the badge image or host it myself?

No, you must use the image URLs exactly as provided: https://awesome.re/mentioned-badge.svg or https://awesome.re/mentioned-badge-flat.svg. These files are served from the media/ directory in the sindresorhus/awesome repository via the awesome.re CDN, and altering the image violates the usage conventions established in the project documentation.

Where should I place the badge in my repository?

Insert the badge near the top of your README file, typically in a badges section alongside build status or version indicators. This placement ensures visitors immediately see that your project has been recognized by the awesome community, though you may place it anywhere appropriate for your documentation layout.

What if my project is listed in multiple awesome lists?

You can display multiple badges for different awesome lists, or choose the most relevant one. Each badge should link to the specific awesome list that mentions your project, using the markdown template with the appropriate list name and URL substituted for each instance.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}