Frequently Asked Questions

General Questions

What is a GitHub Profile README?

A GitHub Profile README is a special repository that appears at the top of your GitHub profile page. It's created by making a new repository with the same name as your GitHub username and adding a README.md file to it.

Do I need to know Markdown to use this tool?

No! That's the beauty of this tool. You can create a beautiful README without knowing any Markdown. Our builder generates all the Markdown code for you.

Is this tool free to use?

Yes, this tool is completely free to use.

Technical Questions

How do I add GitHub stats to my README?

Our tool automatically generates the necessary code to display your GitHub stats. Just enter your GitHub username in the form, and we'll handle the rest.

Can I customize the theme of my GitHub stats?

Yes, you can customize the theme of your GitHub stats cards. We offer several themes to choose from, and you can also customize the colors.

How do I update my README after creating it?

You can come back to this tool anytime, make your changes, and copy the new markdown. Then, update your README.md file on GitHub with the new content.

Why aren't my GitHub stats showing up?

GitHub stats are generated using an external API. If they're not showing up, it could be due to:

• The API is temporarily down
• Your GitHub username is entered incorrectly
• Your GitHub profile is set to private

Troubleshooting

The copy button isn't working

This could be due to browser permissions. Make sure you've allowed the site to access your clipboard.

My README doesn't look the same on GitHub as it does in the preview

GitHub's markdown renderer might have some differences from our preview. Some advanced formatting or custom HTML might not render exactly the same.

I found a bug or have a feature request

Please report bugs or suggest features by opening an issue on ourGitHub repository.