How to Upload a Markdown Resume to Github

In early on Baronial, I announced on Twitter that I was looking for my side by side role. My tweet included a link to my digital CV and ever since I've received a lot of questions virtually how I built it. So here'southward a curt guide!

This guide is based on a Twitter thread that I saw back in 2017. Unfortunately, I can't remember who posted it… but if it was you, delight know that I really appreciate you!

⚠️ Prerequisites:

• GitHub account
• Condolement with Markdown

✅ Steps:

1. Create a new public repository on GitHub
2. Enable GitHub Pages for your repository
3. Select a theme (design template) for your CV
4. Write your CV in Markdown
5. Enjoy 💅🏼
6. Optional: Set up up a custom domain
7. Testify me your CV 💌

Create a new public repository on GitHub

Everything nosotros need for our digital CV will live in a repository on GitHub.

To start, create a new repository without a template.

Cull a name (I called my cv) and include a clarification if you want. Make sure information technology's public.

This digital CV will be hosted with GitHub Pages, which requires your repository to exist public.

And finally, don't initialize it with anything.

While you won't be importing an existing repository, it helps makes the procedure less complicated to start with a completely blank repository. You'll see why later!

Enable GitHub Pages for your repository

Your digital CV will be hosted with GitHub Pages. GitHub Pages allows you lot to host personal and projection pages straight from a GitHub repository. Information technology's slap-up because information technology's free and the functionality is built-in to GitHub so at that place's no demand for an additional account or a circuitous build pipeline.

To enable GitHub Pages for your CV, become to your repository's Settings folio.

Scroll until you find the GitHub Pages section. There are two subsections here: Source and Theme Chooser.

Under Source, it should say, "GitHub Pages is currently disabled. You must first add content to your repository before you can publish a GitHub Pages site." Considering your repository is empty, you have no branches and you lot're unable to select a source. That's ok! This will be taken care of momentarily.

The subsection you lot want is Theme Chooser. Hither, you'll select a pattern template for your site. This will then create a gh-pages branch and publish your site with your selected theme from that branch.

All of the options are Jekyll themes. If you don't know Jekyll, that'southward ok. This guide will walk you through the necessary configuration. Honestly, I have no thought how Jekyll works beyond GitHub Pages templates.

Select a theme (blueprint template) for your CV

CVs are supposed to give future employers an idea of who yous are - so choose a theme that speaks to yous! For this guide, nosotros'll continue with the "Minimal" theme as an example because that'southward the i I use for my CV.

Once yous select your theme, yous'll be prompted to edit a new index.md file.

Before you dive into that, there are a few things that happened in the background that you should know nearly…

• A new gh-pages branch was created (as mentioned earlier).
• This index.doctor file was created.
• Jekyll theme was set up to "Minimal".

GitHub Pages confirms your theme choice by creating a file called _config.yml . By default, this file will only contain a theme field with your option.

Here's what the _config.yml will look like if yous select the "Minimal" theme:

For my CV, I likewise added title and description fields:

You lot can cheque out all of the configuration possibilities in the Jekyll documentation.

Write your CV in Markdown

Alright, back to the generated file. This is where all of the content for your CV will be.

Starting time, you should rename that index.md file to README.md . This is optional, but having it every bit a README allows people to see your CV's content immediately when they visit your repository. This is especially useful if you decide to pin your CV repository to your GitHub profile.

If at that place's no index.md present, then your README volition piece of work automatically with GitHub Pages - no additional configuration required.

Then, you tin write your CV ✍🏻

You lot'll write and style your content using Markdown and so it will be rendered according to your selected theme.

For tips on how to showcase your skills finer, I'd recommend Monica Lent's article: seven software developer resume tips to assistance y'all stand out. If yous're looking for inspiration on how to way your content in Markdown, you tin as well cheque out my digital CV.

In one case y'all're satisfied, commit your changes to the gh-pages branch.

Enjoy your new digital CV

It might take a few minutes to go live - merely your fresh, new, digital CV should now exist bachelor on the interweb 🎉

In most cases, your folio will be hosted at the following url:

<github-username>.github.io/<repository-proper noun>

You tin can e'er confirm that your CV is published and what the url is past navigating back to the GitHub Pages section in your repository's settings.

If your digital CV isn't updating after pushing a commit and waiting a few minutes, try doing a difficult refresh.

Optional: Gear up a custom domain

Custom domains tin can help your CV stand out - or alternatively, utilise your digital CV as a personal website.

Admittedly I've never set up a custom domain for my CV, but in that location are stride-by-stride instructions for how to do this in the GitHub documentation.

If you're not sure where to get domains, I like Namecheap.

Show me your CV

If yous followed this guide and built a digital CV, I'd dearest to see it!

Tweet me a link @carolstran and please share this article if you plant it useful 💖

Like my work?

Let me send updates to your inbox (and 1 day, a newsletter).

Unsubscribe someday. No spam 🤖

shanahanhiphell1958.blogspot.com

Source: https://workwithcarolyn.com/blog/digital-cv-guide

Share this post