Search code examples
githubmarkdown

How to display readme.md file on profile in Github?

I have created a README.md file in my username.github.io repository but it doesn't appear on my profile page:

enter image description here

Solution

  • Profile READMEs must be located in a public repository named after your GitHub user name. This is different from your GitHub Pages User site.

    Assuming your GitHub username is username:

    • Your GitHub Pages User Site should be in a repository named username.github.io. You already have one of these.

    • The repository for your profile README.md should just be named username. Create a new repository with that name and add your README.md there.