Create a GitHub Profile README.md with widgets

Create a GitHub Profile README.md with widgets

Written by Kritika on Oct 3rd, 2021 ・ Views ・ Report Post

Kritika Visit User Profile

Ever since GitHub released the feature that allows users to add a profile level Readme to showcase their interests, bio, contributions, etc., I have been wanting to add one to my GitHub profile. While I did that, I thought why not document this, and what better way than a blog post. 

What am I going to do?

  1. Create a new repository using the GitHub web interface with a readme file.
  2. Add content into that readme file using markdown.
  3. Add some widgets to power the GitHub profile. Eg GitHub stats, GitHub streak, StackOverflow reputation , top languages etc.

Create a Readme GitHub profile

Step 1: Go to https://github.com/ and on the top far right corner, click the + icon and click on New Repository.

Step 2: Enter the repository name. It should be the same as your GitHub username. In my case, my GitHub username is kritika-pattalam so I entered that.

Step 3: Make sure you select the option public . (P.S Github profile will be available for others to view only if the repository is public.)

Step 4: Select Initialize this repository with a README.

Step 5: Click  Create Repository

nmxf3dt5m5yqkdyp16m1.jpeg

Your GitHub profile readme file has been created with dummy content for you to get started.

Dummy Markdown section after new repository creation.jpeg

🤩 Our Amazing Sponsors 👇
DigitalOcean View Website
DigitalOcean offers a simple and reliable cloud hosting solution that enables developers to get their website or application up and running quickly.
Laravel News View Website
Laravel News keeps you up to date with everything Laravel. Everything from framework news to new community packages, Laravel tutorials, and more.
Genesis View Website
A Laravel Starter Kit that includes Authentication, User Dashboard, Edit Profile, and a set of UI Components.

Adding Markdown to the Readme.md file

Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. It can be used to add anything to a readme file. Even though it's a markup language it does not accept CSS classes, hence the plain old HTML attributes such as width for an image, align="center" for a paragraph tag can be used to align the layout. Read more about markdown Markdown cheatsheet

Widgets

You can add the below code to your markdown file, replacing {username} with your GitHub profile username. There are more options such as choosing your own themes, whether you want to show the icons or not. To know more about the options, you can refer Github Widgets

#### Github Stats
<img src="https://github-readme-stats.vercel.app/api?username={username}&show_icons=true&theme=gotham" alt="github stats" width="45%" align="right"/>

### Github Streaks
<img src="https://github-readme-streak-stats.herokuapp.com/?user=kritika-pattalam&theme=dark" width="48%" >

### Top Languages
 ![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=kritika-pattalam&layout=compact)

Stackoverflow reputation using Flair

If you have a StackOverflow account, adding this to your GitHub profile to reflect your SO reputation is straightforward.

Step 1: Go to your StackOverflow account, and click on edit profile and settings. Step 2: Scroll down to Flair found under site settings. Step 3: Copy paste the code snippet to your readme file

Stackoverflow profile - on how to get the flair

Finally, once you are done with all the changes, commit the readme.md file and you should be able to see your Readme.md GitHub profile. You can see mine at Kritika's Github Profile.

Let me know your thoughts in the comments below. Feedback and suggestions are Welcome.!!!!

References:

Lets connect on Twitter | LinkedIn for more web development related chats.

Comments (0)