Customize your github profile with a markdown file

Eniola Olaleye
3 min readDec 11, 2020

Github recently introduced a new feature for Developers which allow you pin a markdown file (called special repository) to your GitHub profile, to let you describe more about your skill sets , what project you are working on and display a general overview of your portfolio.

Some of the interesting ones i have seen:

Rising Odegua
Bamigbade Opeyemi
Eniola Olaleye
Galileo himself!

Markdown is a lightweight markup language with plain-text-formatting syntax, it is used for formatting readme files, for writing messages in online discussion forums, and to create rich text using text editor.

MARKDOWN SYNTAX

markdown has a very simple syntax the major one we would use is how to add an image , create headers , list and links.

Headers :

#an <h1> tag , ## an<h2> tag , #### an <h4> tag

Emphasis:

*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
_You **can** combine them_

LISTS:

* Item 1
* Item 2
* Item 2a
* Item 2b

IMAGES:

![GitHub Logo](/images/logo.png)
Format: ![Alt Text](url)

Links

http://github.com - automatic!
[GitHub](http://github.com)

MAIN DEAL

we would now see how we can pin a readme file to create a beautiful github profile.

PREREQUISITES:

  1. A GitHub account
  2. Basic mark down Knowledge (which we have covered above)
  3. Willingness to learn

STEPS

  1. create a new special repository with your GitHub username my username is galileoSolution so i created a new repository called galileoSolution.

2. Ensure the repository is set public and click on the checkbox: add a readme file then click on create repository.

After this you are set for greatness!

After creating the repository since you added a readme file GitHub helps you with a free template which you can edit to suite your personality!

sample template

Now we are all set you can edit this add texts, images ,tables and list.

This is my own finished copy!

Galileo

If this has helped you give it a clap and i would also like to see your profile if you are done send a link to your GitHub profile or a screen shot thank you!

mine is here — my GitHub

connect with me on twitter and linkedin.

muchas gracias.

--

--