Today Github is the behemoth platform for open-source projects. There would not be a single person in the open-source community who doesn't use GitHub. And there could be a minuscule number of developers who don't have a GitHub profile. GitHub is not only home for the best open-source projects but also a place where developers could showcase their talent via a panoply of projects.
Below is the default, pedestrian GitHub profile page that shows the name, contact information, and some repositories.
A few months back, Github launched a new feature that lets us customize our profile page using the README file. README is a repository or project-level file used for documenting the project. README.md is written in
Markdown(lightweight markup language) that converts text to HTML.
In this blog post, I will show how I customized my mundane Github profile using the README file.
Create a new repository with the username
1. Make sure your repository name matches the Github username. 2. Make a public repository. 3. Add README.md to it.
Adding a banner image
I'm keeping this image in the
img directory. Now I want it to be at the top, so I put the link to the banner image on the first line of my README file.
To add an image in the README file, use the following syntax.
![Pratik's GitHub Banner](./img/banner1.png)
If you want to make an image, a link that will open your blog or some other sites, use the following syntax.
[![Pratik's GitHub Banner](./img/banner1.png)](https://pratikjagrut.dev)
Add a bio
GitHub initializes README with a few bullet points. I used the same template to add my bio.
README file is highly customizable using Markdown. Checkout the Markdown syntax guide
Once we've got the badge, we can then put it anywhere we want.
Listing latest blog posts
Showing GitHub statistics
Github Readme stats shows the statistics of our profile in various beautiful cards.
There are lots of customizations we can do with the GitHub profile. Below are some valuable resources which could help to add some advance elements..
I hope you found this blog helpful and thank you for reading it please give your feedback in the comment section below.
Did you find this article valuable?
Support Pratik Jagrut by becoming a sponsor. Any amount is appreciated!