loading...
Cover image for GitHub Secret: Add a README to your Profile

GitHub Secret: Add a README to your Profile

puf17640 profile image Julian Pufler ・1 min read

So I just played around with the 'repository creation' page on GitHub and found a secret which I wasn't aware they added, so I thought I'd share it with you guys!

If you try creating a repository named exactly after your GitHub username, a little message pops up telling you that you've found a secret. Let me show you!

GIF

You found a secret! puf17640/puf17640 is a ✨special ✨ repository that you can use to add a README.md to your GitHub profile. Make sure it’s public and initialize it with a README to get started.

It's as easy as that, create a public repository with your username and add a README.md file to it. The README will then be automatically added to your profile.
You can see my GitHub profile below.

puf17640 GitHub

Since it's markdown, you can add links and pictures and everything else you can add to a normal README file.
Awesome, isn't it?

Have fun adding a detailed and cool description to your GitHub profile! I will update mine soon since what you see above is just what I played around with, I went straight to writing the article you just read! 🤪

Posted on by:

puf17640 profile

Julian Pufler

@puf17640

19 years old. IT student from Vienna. Mostly NodeJS, C#, Java, Python. Core-Team Member of disease.sh

Discussion

markdown guide
 

That's so great. I even added a pure CSS clock to show visitor staying time!

There's a bug I've just reported: for any h1/h2/h3/h4 headings, click the link icon on its left, then your user name under your avatar will be messed up!

 

Nice find! What device did you experience this problem on? On mobile it seems to be not the case.

 

Virtually any desktop browser, I've tested chrome & firefox in win, safari & chrome in macos, all latest. Wide/normal screen only, mobile layout doesn't have the bug.

dev-to-uploads.s3.amazonaws.com/i/...

But don't worry, I've reported to GitHub and expect it to be fixed soon.

 

I have created a repository for awesome github profile aims to collect the all awesome beautiful READMEs profile and make your Profile look good & Inspire other's.

 

Awesome! This will add a nice touch to my GitHub profile. Thanks!!

 

that's pretty neat, my github profile looks great now

 

feel free to post a screenshot here! or you can also post your github profile link so I can check it out 👍

 

Oh nice! It is github.com/fhek789

 

What did you use to record GIF? screentogif?

 

I record my screen using the native macOS screen recording app and then convert it to GIF using some random website, I normally just search for "video to gif" and then take the first one that comes up

 
  • youtu.be/x0Boemw9teU
  • I have created a video for markdown tutorial and demo for github profile readme!
  • kindly check it!
 

I have created a repository for awesome github profile aims to collect the all awesome beautiful READMEs profile and make your Profile look good & Inspire other's.