DEV Community

Cover image for Github Profile Readme.md
DesireeJoy
DesireeJoy

Posted on

Github Profile Readme.md

Does your github page lack some pizazz?

In a place where it pays to stand out, github profile pages are pretty bland. A solid contributions grid helps, but ultimately a little more is needed. Recently Github introduced the ability to make a custom readme which allows you to personalize your profile.

How do you do it?

Well first you create a new repository that has the same name as your github username.

e.g. My username is DesireeJoy so my github repo is DesireeJoy.
Make sure you create a readme.md with your new repo. That is where the magic happens.

The readme content is what will display on your profile.

Githubs How-To

What is a readme?

A readme.md file is a file you, ideally, create for ever repo. It is a place for you to tell visitors to your page what it is this repo is about. You can tell what languages are used, provide run/build commands, list dependencies, link to the functioning project, give it's history, thank collaborators etc etc... The possibilities are endless. I bet you can see now how you can use this for your own personal readme? right?

What should I add?

This is the part where you can make your profile unique to you and catch everyone's attention.

As someone switching over from a media design field I opted for an eye catching banner to draw my visitors in. I also kept it simple.
A short greeting, no bio because my banner handled that for me. You may want to consider one.

My primary hope is for other developers to visit and want to collaborate on projects. With that in mind my first lists were "I'm currently learning" & "I'm looking to collaborate on..."

You work with your priorities.

View my Profile
Screenshot of my Github Profile

What language do I use?

Primarily readme's are in Markdown, however, because I wanted to tweak a few things my personal readme ended up being a mix of markdown and html.

Great section ideas

  • Short bio
  • Learning list
  • Featured Projects
  • Open Source bonus!
  • Skill list
  • Certifications

Links to resources

https://help.smash.gg/en/articles/1987102-customizing-text-with-markdown -- Markdown help

https://dev.to/envoy_/150-badges-for-github-pnk - Skills Badges

https://www.markdownguide.org/basic-syntax/ More markdown syntax!

Do you have an awesome github profile page? Please link it in the comments. I would love to see them!

Top comments (0)