CODEWITHSUNDEEP
githubmarkdownreadme
Programmer Gaurav
Programmer Gaurav

Reputation: 449

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

Upvotes: 4

Views: 8000

Answers (7)

Chris
Chris

Reputation: 136958

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.

Upvotes: 15

Md. Nur Habib
Md. Nur Habib

Reputation: 1

create a repository with your username. your profile readme file will be created and then you can edit it as you

Upvotes: -3

Ashif
Ashif

Reputation: 11

You get a green pop-up window on the right of your repository where README.md is stored. Click add to profile to make it work.

Upvotes: 0

Nick Dong
Nick Dong

Reputation: 3736

The repository of username.github.io should be https://github.com/username/username.github.io It is a github page, see types-of-github-pages-sites

To publish a user site, you must create a repository owned by your user account that's named <username>.github.io.

The repository of profile with README.md should be https://github.com/username/username

See managing-your-profile-readme

It is your profile information.

You've created a repository with a name that matches your GitHub username. The repository is public. The repository contains a file named README.md in its root. The README.md file contains any content.

And you need to click the Share to profile button after creating the repository to show the content to your profile.

So, They are different repositories.

See also awesome-github-profile-readme, github-readme-stats

Upvotes: 2

Sabesan
Sabesan

Reputation: 702

Create a repo that is named the same as your username. let's assume your username is ProgrammerGaurav. so you need to create a new repository with the name ProgrammerGaurav.

Note: at the time of this writing, in order to access the profile README feature, the letter-casing must match your GitHub username and your GitHub repository visibility should be in public.

Create a README inside that repo and edit it to fit your needs.

Upvotes: 2

Stackunderflow
Stackunderflow

Reputation: 59

we can create via visual studio editor. create a file with name README.md and in this file create your page profile page. And push to github via version control

Upvotes: 2

Shreya Maheshwari
Shreya Maheshwari

Reputation: 71

You just have to create a new repository with the name as your username (ProgrammerGaurav) and create a README.md in that repository.

Upvotes: 4

Related Questions