FAQ (PLEASE READ FIRST)

[rickstaa]

Here you can find frequently asked questions. Please check this list and the already asked questions before posting your question. For common error codes see Common Error Codes.

• General questions
  • My card displays an error
  • I could not figure out how to deploy on my own Vercel instance
  • How to count private stats?
  • My card is not updating
• Stats card related questions
  • Number of commits is incorrect
• Language card related questions
  • How to hide Jupyter Notebook?
  • Language card incorrect

General questions

My card displays an error

Please check common error codes and existing issues before creating a new issue.

I could not figure out how to deploy on my own Vercel instance

Please check out the docs or the accompanying Youtube tutorial by @codeSTACKr.

How to count private stats?

By default, the stats card shows contributions only from public repositories. To show your private contributions, you should deploy your own instance using your own GitHub API token, allowing you to see your private data.

My card is not updating

We use a cache to lower the server load, so please be patient before opening an issue. See https://github.com/anuraghazra/github-readme-stats#gradient-in-bg_color for more information.

Stats card-related questions

Number of commits is incorrect

As we directly use the data provided by Github's GraphQL API, the commits shown on the card are probably correct. Most of the time, people confuse contributions with commits (see #1679 for more information) or are unaware caching is used to reduce the server load (see https://github.com/anuraghazra/github-readme-stats#gradient-in-bg_color). You can check the data we receive by running the following syntax in the GraphQL explorer:

query userInfo($login: String!) {
  user(login: $login) {
    name
    login
    contributionsCollection {
      totalCommitContributions
      restrictedContributionsCount
    }
  }
}

You can then use the following in the query variables field.

{"login": "rickstaa"}

If you enabled the include_all_commits option, the total commits are fetched using Github's REST API instead. You can check the total commits we receive from this API using the following syntax in the reqbin API tool:

https://api.github.com/search/commits?q=author:<USER_NAME>

Please be aware that this, by default, only fetches your public commits. You must include an Authorization token if you want to retrieve your private commits (see https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api#authentication). If you still think the number of commits is incorrect, please open an issue.

Language card-related questions

How to hide Jupyter Notebook?

You can use the hide parameter (i.e. &hide=jupyter%20notebook). See https://github.com/anuraghazra/github-readme-stats#hiding-individual-stats for more information.

Language card is incorrect

As we directly use the data provided by Github's GraphQL API, the results shown on the card are probably correct. Most of the time, people are unaware that caching is used to reduce the server load (see https://github.com/anuraghazra/github-readme-stats#gradient-in-bg_color), that data from forks are not included (see #1255) or that there exists an upstream issue with the GraphQL API that prevents us from getting more accurate language results (see #1801 (comment)). You can check the data we receive by running the following syntax in the GraphQL explorer:

query userInfo($login: String!) {
  user(login: $login) {
    # fetch only owner repos & not forks
    repositories(ownerAffiliations: OWNER, isFork: false, first: 100) {
      nodes {
        name
        languages(first: 10, orderBy: {field: SIZE, direction: DESC}) {
          edges {
            size
            node {
              color
              name
            }
          }
        }
      }
    }
  }
}

You can then use the following in the query variables field.

{"login": "rickstaa"}

[rickstaa]

Please comment below if you think a commonly asked question is missing from the FAQ 👍🏻.

[rassellek]

The error "no description provided" appears in "GitHub Extra Pins" while the description is present in the repository itself.

https://github.com/rassellek

[rickstaa]

@rassellek That looks like a bug. Please open a bug report on https://github.com/anuraghazra/github-readme-stats/issues/new?assignees=&labels=bug&template=bug_report.yml. 👍🏻