GitHub recently released a feature that allows users to create a profile-level README to display prominently on their GitHub profile. This article walks through how to access this new feature.
Check out My GitHub Profile README šĀ Here
Why READMEsš?
The GitHub profile-level README feature allows more content than the bio profile, supports markdown, which means that you can play around with content more visually (Did someone say GIFs!?) and the README is significantly more visible as it is placed above-pinned repositories and takes up as much space above the fold of the webpage as you like.
In my view, the README profile level tends to be a great extension of the standard that many GitHub users are already familiar with.
How do I create a profileĀ README?
The README profile is created by creating a new repository with the same name as your user name.
For example, my GitHub username is Arunkumarvallal so I created a new repository with the name Arunkumarvallal.
Create a new repository with the same name (including casing) as your GitHub username: https://github.com/new
Create a README.md file inside the new repo with content. README files can contain many elements like the following: Images (SVG, png, etcā¦), Gifs, Texts, Emojis. You can also display
GitHub Profile StatsĀ Card
Visitors CountĀ Badge
Latest dev.to blogs dynamically (GithubĀ Action)
Latest medium blogs dynamically (GithubĀ Action)
Commit your cushy new README!
If you're on GitHub's web interface you can choose to commit directly to the repository main branch (i.e., master or main) which will make it immediately visible on your profile)
Already have a repo-named username/username?
If you are interested in setting up a profile-level README then you can rename the repository or repurpose its existing README based on what makes the most sense in your particular situation.
Check the cache message that āØSpecial āØrepository "You have found aĀ secret"
NOTE: As I have already created the repo hence it's showing
"The repo already exists"
GitHub Profile README š Generator
If you are new to GitHub and do not know how to do a Profile README. Here is a solution for you.
Click here to find the solution.
Check the below link for Innovative GitHub ProfileĀ READMEš
There are many people who are done there profile README in innovative ways. They used their skills in their ReadMe. There are a bunch of people I think they did their README in an innovative way and I have listed them down in a link.
Top comments (0)