GitHub has a feature that allows you to create a profile-level README repository that will automatically appear on your profile page. You can edit your profile README with Markdown to create a personalized profile. This article will walk you through setting up your GitHub profile-level repository.
Let’s get started!
My current GitHub profile looks like this:
Prerequisites
If you don’t already have a GitHub account, your first step is to create one. Head over to https://github.com/ and enter your email address and sign up. This will bring you to the signup page where you will create your unique GitHub user name.
Now that you have your GitHub account, to customize your profile, you need to create a repo with the same name as your GitHub username.
Step 1.
From the GitHub page, click on the “+” icon and select New repository from the dropdown menu:
Step 2.
On the create a new repository page, make the following changes:
-
Enter your GitHub username in the Repository name box.
-
Set the Visibility of the repository to “public”.
-
Check the box for Add a README file.
-
Click on Create repository.
After clicking on Create repository, you will be taken taken to your new repository, which will look like this:
Step 3:
To make changes to your profile, you can click the pencil icon to edit the README.md:
Now you are in Edit mode. GitHub automatically generates some example content that you can use if desired. It is located between the <!– and –> tags and will not be displayed unless you remove the comment tags.
NOTE: You can click on the Preview tab at any time to get a preview of the changes you make before making them live.
Step 4:
Make a change to your profile and then “commit” the changes to the repository by clicking the Commit changes button:
Step 5:
Review your changes by clicking on your profile name and then you should see your new profile page displayed.