README Generator

How to Add Pinned Repository Cards to Your GitHub Profile README

Pinned repository cards embed visual project showcases directly in your README, displaying each project's name, description, star count, fork count, and primary language. Unlike GitHub's native pinned repositories (which appear below your README), these cards appear inside your README where you control their placement and context. This guide uses the anuraghazra/github-readme-stats pin card feature — the same project that generates your stats and language cards.

Quick Setup Steps

  1. 1

    Step 1: Identify 2-4 public repositories you want to feature in your profile README.

  2. 2

    Step 2: Add a repository card for each: [![Card](https://github-readme-stats.vercel.app/api/pin/?username=YOUR_USERNAME&repo=REPO_NAME&theme=tokyonight)](https://github.com/YOUR_USERNAME/REPO_NAME)

  3. 3

    Step 3: Replace YOUR_USERNAME and REPO_NAME with the actual values for each repository.

  4. 4

    Step 4: For a two-column layout, wrap pairs of cards in <div align='center'> HTML tags.

  5. 5

    Step 5: Add one sentence of context before each card to explain what the project is, then commit and push.

What Are Pinned Repository Cards?

Pinned repository cards are SVG images generated by github-readme-stats that display a single repository's metadata: the repo name, description (first 100 characters), star count, fork count, open issues count, and primary coding language with its color dot. They look like polished project tiles and give your README a portfolio-style layout without requiring custom HTML or external hosting.

The cards pull live data from the GitHub API, so star and fork counts update automatically as your projects gain traction. They work for any public repository — including repositories you have contributed to that are owned by other users or organizations.

How to Add Pinned Repository Cards

Add this to your README for each repository you want to feature:

[![Repo Card](https://github-readme-stats.vercel.app/api/pin/?username=YOUR_USERNAME&repo=REPO_NAME&theme=tokyonight)](https://github.com/YOUR_USERNAME/REPO_NAME)

For a two-column project showcase:

<div align="center">
  <a href="https://github.com/YOUR_USERNAME/REPO_ONE">
    <img src="https://github-readme-stats.vercel.app/api/pin/?username=YOUR_USERNAME&repo=REPO_ONE&theme=tokyonight" />
  </a>
  <a href="https://github.com/YOUR_USERNAME/REPO_TWO">
    <img src="https://github-readme-stats.vercel.app/api/pin/?username=YOUR_USERNAME&repo=REPO_TWO&theme=tokyonight" />
  </a>
</div>

Replace YOUR_USERNAME and REPO_NAME with actual values. The card links to the repository page, making it clickable without additional configuration.

Customizing Pinned Repository Cards

The pin cards support the same theming system as the stats card:

  • theme: tokyonight, radical, dark, transparent, github_dark, etc.
  • show_owner=true: Show the repository owner's username above the repo name (useful for repos you contribute to but don't own)
  • description_lines_count: Control the number of description lines shown (1-3)
  • hide_border=true: Remove the card border for a cleaner embedded look

For a curated project section, write a brief context sentence before each card:

**My most-starred project — a CLI tool for managing dotfiles across machines:**

[![Dotfiles Manager](https://github-readme-stats.vercel.app/api/pin/?username=yourname&repo=dotfiles-manager&theme=tokyonight)](https://github.com/yourname/dotfiles-manager)

This context transforms the card from a raw stat into a project story — which is more memorable and useful than the card alone.

Troubleshooting Pinned Repository Cards

If the card shows 'Repo not found', verify the repository name is spelled exactly correctly (case-insensitive for most repos but exact spelling is required). Also confirm the repository is public — pinned cards cannot display private repositories without a personal access token set up in a self-hosted instance.

If the description is cut off, the card limits descriptions to approximately 100 characters. Edit your repository's description on GitHub to ensure the most important information appears in the first 100 characters.

If stars and forks show as 0 for a repo that has activity, check that the repo name in the URL is the current name — renamed repositories redirect on GitHub.com but the stats API needs the exact current name.

Frequently Asked Questions

How do I add repository cards to my GitHub README?

Use: `[![Card](https://github-readme-stats.vercel.app/api/pin/?username=YOUR_USERNAME&repo=REPO_NAME&theme=tokyonight)](https://github.com/YOUR_USERNAME/REPO_NAME)`. For multiple cards, wrap two img tags in a <div align='center'> for a two-column layout. Feature 2-4 of your best projects.

Can I add repository cards for repos I don't own?

Yes. Use the owner's username in the username parameter and add show_owner=true to display whose repo it is. This is useful for showcasing significant contributions to popular open source projects. The card will display correctly for any public repository.

Why does my repository card show the wrong description?

The card reads the repository's About description set on GitHub (the text under Settings → General → Description). If you want a different description in the card, edit the repository's About field on GitHub. The card does not read from README content.

How many repository cards should I add to my GitHub README?

2-4 cards is the typical range. More than 4 cards can make the projects section feel overwhelming. Choose your best 2-3 projects that best represent your skills and are most likely to impress the specific audience you are targeting (recruiters, collaborators, or the developer community).

From Our Blog

Generate Your GitHub Profile README

Generate a GitHub profile README featuring Pinned Repo Cards with AI

Try It Free — No Sign Up