loading...
Cover image for How to use your Github's profile readme as a portfolio page

How to use your Github's profile readme as a portfolio page

denvermullets profile image denvermullets ・3 min read

A couple of months ago Github released the ability for each account to have its own profile readme that displays when someone visits your Github. There's lots of fun and neat ways that people have been sprucing theirs up. There are quite a few repo's that collect some of the fun ones and even clone down their readme file and modify your repo readme so that yours looks just like it. If you want to browse some other profiles, take a look at these:

To actually create your own all you need to do is to create a repo that matches your Github username. Pretty simple! Make sure you create that Read me file since this is where you'll be putting in any information to display.

mock github signup page

Now while it's fun to make your Github profile look like it came straight out of Myspace, I actually think as a newer developer you might want to try to make it be your portfolio for a while. Back when I was a motion designer, people that were hiring would pay more attention to your reel than your portfolio page, and you typically wanted to keep that video under 60 seconds. People don't have a long attention span, especially if what they're looking at is in rough shape. The thing is, I think, most people that are looking to hire you are going to look at your Github page. I'm not sure I see the value in having them click on your portfolio only to click on your projects link or your Github profile link. Let's make it a one stop shop!

This is how I have mine setup and I'll explain some of the extra stuff you might see. My Github for reference

denvermullet's github about me

I'm a firm believer in keeping things simple and I try to keep things as minimal as I can, but sometimes that slips away. Outside of the basic information I put in my profile I found this great repo that has lots of different widgets that you can insert into your readme to spruce it up. There's quite a few different options that you might want to check out.

The other thing on my profile is a rolling weekly stat of what languages I've been programming in. I don't think this is particularly important to anyone aside from me but as a long time Last.fm fan, I kinda grew to dig these kind of constantly updating charts. For this one you'll need some 3rd party help from a Wakatime plugin. You set that up and then create a Github action that updates your readme every day to update your stats. I'll provide another repo that connects in to your weekly stats if you want to have more customization, but the first link is the one I use.

Cool, now that you have that all setup here are the reasons why I think this is a good way to present yourself to employers when you're new.

  1. It saves you from yourself. Sometimes having a simple design is better than having a bad design
  2. It forces you to spruce up your project Readme's which is something every developer should be trying to keep updated
  3. You don't have to worry about hosting a site OR listing your portfolio site as a project you've worked on, plus it's responsive already
  4. With pinning of repos, or creating custom links using one of the above methods, you can still highlight certain projects that you want employers to see

I'm not sure this is the way to do a portfolio, but it's certainly a fun way and lets you experiment with some new stuff and be creative. Good luck out there and let me know if you come across any other snazzy looking profiles!

Discussion

pic
Editor guide
Collapse
fennecdjay profile image
Jérémie Astor

Funnily enough, I started mine from a generator, added a few things, removed other, so the whole thing is pretty basic, but someone just forked it! (And I have no clue why.)

Collapse
denvermullets profile image
denvermullets Author

that's the way it goes sometimes! if you dig thru those repo's there's some crazy ones. it took me a little bit to get it to function the way i wanted it to, almost too many options

Collapse
fennecdjay profile image
Jérémie Astor

I saw some pretty pretty ones, yes! What I feel his strange is that mine is not of that kind, I barely put ten minutes on it (like something I'd do to fill ten minutes on a ready sunday).
You can check my README profound commonness here.

Thread Thread
denvermullets profile image
denvermullets Author

those are cool little badges, where'd you find those?

Thread Thread
fennecdjay profile image
Jérémie Astor

I think I just githubed (as in googled them) 😄
The coverage one is from my CI, but I think it is broken 😕

Collapse
codedgar profile image
codedgar

This is so cool! I feel like github profiles should be used as portfolios and professional profiles, doing this is the last step to make them that

Collapse
denvermullets profile image
denvermullets Author

it certainly makes a lot of sense to just make your github a portfolio. everything you need to know is right there! i was pretty blown away with how creative people are with them.

Collapse
nicolasomar profile image
Nicolás Omar González Passerino

Thank you very much for the article, the examples you provided gave me a lot of ideas.
I want to contribute with my profile

All feedback will be appreciated :)