Tutorial: Add your Holopin badges to your GitHub profile

Cover Image for Tutorial: Add your Holopin badges to your GitHub profile
Rob Phipps
Rob Phipps
Engineer @ Holopin

Making your GitHub profile more awesome!

You probably use a code sharing site like GitHub, GitLab or Bitbucket to showcase your l33t coding skills, and act as a portfolio of the sort of things you work on, but it's probably looking a bit text-heavy?

We're here to help you change that! With Holopin, you can embed a live copy of your badge board so all your badges get automatically added to your profile.

For this guide, we're going to work with GitHub. But these steps should work for any site that allows you to use a Markdown formatted file as your profile!

Markdown + Holopin = 💖

Markdown is a markup language that lets you write documents with rich formatting like headings, bullet lists, tables, bold, underline and italic text but in a way that's easy to type (no angle brackets and keywords like in HTML), fits in a completely plain text file and still looks readable even as plain text. For example, you can do things like this:

# This is a heading

This is some **bold** text, and some _italics_, and this is **really** important. Markdown is

1. Easy to type
2. Plain text
3. Readable

(this whole blog post was written in Markdown!)

Step 1: Create a personal README on GitHub

Jump onto your GitHub account, and hop to your profile. If you've not got a personal README, you'll need to create one. Use the + symbol and choose New repository:

GitHub new repository dropdown

Once you're there, set the repository name to be your username and you'll see a message to show you're creating a "special" repo:

GitHub special repo message

Now initialise that with a README.md:

GitHub initialise with README

Once your repo is ready, you can hit the button to open an editor in browser:

GitHub edit README

This is the place where you can write a bit about yourself, and add some links to your social media.

Step 2: Customize your Holopin board 🪄

If you haven't already, you'll need to create a Holopin account. Hop over to holopin.io to get started (I hear there's early bird badges available if you're quick too 👀).

Once you've got your Holopin account, head to your profile and add your badges from the inventory:

rphi's Holopin profile

Got it looking nice? Great. You may have spotted there's a bit of code under your board... this is the magic to get things showing on sites other than Holopin.

Step 3: Add your Holopin board to your GitHub profile

This is where the Markdown comes into action. That link looks like this, and you can find it at the bottom of your board:

[![@rphi's Holopin board](https://holopin.io/api/user/board?user=rphi)](https://holopin.io/@rphi)
Congrats, you found a holobyte!

But what does it mean? We've got two things going on here, first we're including the image with ![](), and then we're linking that image to your Holopin profile with [](). This is the same as if you were linking to an image on the web, but we're using the Holopin API to generate the image on the fly.

Paste in your Holopin embed, hit commit, and if all has gone to plan, your board will now be in pride of place on your GitHub profile page!

Whenever you edit your board on the Holopin site, your GitHub profile will update automatically.

rphi's GitHub profile

We'd love to see how you've incorporated your Holopin badges on your GitHub profile! Tag @holopin_ on Twitter and we'll retweet it with the community... and maybe even send you a badge or two!

Start issuing the coolest badges with Holopin today

Loved by people and businesses alike, Holopin is the best way to issue digital badges. Choose from a variety of features and pricing plans to suit your needs.