Hi there, I'm Katie! 🙋🏻♀️
This is a fuss-free, simple guide to create your GitHub portfolio.
It's perfect for
- Beginners in data science who wants to showcase samples of work, or projects.
- Serves as a digital resume and proof that you have the skills in your resume.
- A fun way to keep track of your projects.
Why I created this repo?
- I was once intimidated by GitHub myself. I signed up in March, but left it aside as I did not understand how it works.
- Since then, I have learnt how to use it (I'm quite obsessed with writing in Markdowns 😆), so I would love to share this knowledge with everyone. 🙂
- How to Create Your Profile?
- How to Customize Markdown files?
- How to Create New Repository?
- How to Create Subfolders in your Repository?
- How to Upload Projects in your Repository?
- How to Fork a Repository?
You can learn how to do this neat table of contents too! It's very easy. 😉
Let's understand some of the alien terms that you will see on GitHub.
📌 Repository/repo means folder. It is similar to creating folders on your computer. Each repository represents one folder. You can create multiple repositories for different projects.
📌 README.md is a default note, or summary that is usually included in each repo. It acts as the "homepage" of your repo where you can introduce the project, provide a summary, or anything - so feel free to write it.
📌 Fork in layman means copy + paste. Let's say you want to make a copy of this guide, have access to it, and edit and play around with the codes. You can do it! Any changes made in your copy of the file would not be reflected in this guide. I'll teach you how to do it below.
You do not need to download the GitHub Desktop to set up your portfolio. Your browser would do the job just fine. 🙂
Are you interested in creating a Profile that appears on your GitHub homepage, like mine?
Step 1: Click on + and New Repository at top right of the page.
Step 2: Create a new repository with the exact name as your username.
My username is "katiehuangx", so I created a new repository named "katiehuangx". This repository will contain the write-up of your profile.
The format of the file is Markdown (.md). Its default name is README.md, so you can leave it as that.
Step 3: To edit your Profile or Markdown file, hover over the pencil ✏️ icon on your right and click Edit this file.
Now you can start to write your profile! 😄 Once you're happy with the contents, scroll down and click Commit changes.
It's entirely up to you and your creativity! Most people would include:
- An introduction of yourself
- Skills like Data Analysis, SQL, Python, Tableau, Web Development, etc
- Fancier things like visitor count, clickable icons, etc (can't help you with this as I've not learn it yet 😅)
- Projects that you're proud of
For further reading, check out:
- GitHub Managing your profile README - Detailed guide on creating your profile
- Get some inspiration from this post for awesome GitHub profiles.
GitHub's Markdown guides are excellent and comprehensive enough, yet easily understandable. This is where I learn to customize mine too. 🙂
- How to customize Markdown files - Github Basic writing and formatting syntax
- How to create tables - GitHub Organizing information with tables
- How to colour code your SQL, Python, etc code blocks (This is my favourite part!) - GitHub Creating and highlighting code blocks
- Bonus tip: How to add emojis? 🌟🙌🏻🙋🏻♀️📚🌤🐶
- For Windows: Windows logo key + . (period)
- For Mac: Control + Command + Spacebar
Normally what I would do is take a screenshot, or download the image.
Then, I copy the image file and paste in the Markdown file itself. Give it around 3-5 seconds to load the image.
Uploading screenshot...
Successfully uploaded screenshot!
Click Preview to check your newly uploaded image.
Below is the code block for my table of contents.
## Table of Contents
- [How to Create Your Profile?](#how-to-create-your-profile)
- [How to Customize Markdown files?](#how-to-customize-markdown-files)
- [How to Create New Repository?](#how-to-create-new-repository)
To ensure that you retrieve the correct (#xx-xx-xx):
Click on the chain logo beside your title. Right click and open in new tab.
Navigate to the website link and scroll all the way to the end and copy the highlighted ##xx-xx-xx.
Do not include emojis in your title, otherwise the links in the table of contents would not work.
Psst, the links in the table of contents do not work in Preview. You have to Commit changes in order to check if the links work.
If you've seen my 8 Week SQL Challenge repo, I use colour codes for my SQL syntax. It's very easy to do and makes your syntax look professional too.
```sql -- Add 3 backticks followed by sql
SELECT *
FROM student_info
WHERE student_name = 'Katie';
``` -- Add 3 backticks
This is how it will turn out:
SELECT *
FROM student_info
WHERE student_name = 'Katie';Creating a new repo is as easy as creating your profile.
Step 1: Click on New Repository at the top right of the page.
The image below is the default setting. If you forgot to tick Add a README.md, you can create the file separately in the repo later.
And, it's done. You have created your first repo! 😎
Step 1: Navigate to the right side of the page. Click Add File and Create New File.
Step 2: Name your file followed by the extension .md, or your desired format.
Step 1: Navigate to the right side of the page. Click Add File and Upload File.
Step 2: Choose your file, wait for file to load completely and click Commit changes
Once your file is uploaded completely, it will look like the one in my screenshot below. Bigger file size would take a longer time to load. 🙂
And, that's it! It's as simple as that!
Let'say I'm checking out this awesome repo and I'm curious to see how he adds the icons, Twitter button, and all the cool stuffs.
Step 1: Click on the fork🍴 icon at the top right of the page
Step 2: It's done!
GitHub has forked and copied the repo and added it as one of your repo. Now, you can edit the file and learn how to add those fancy, cool stuffs too!
Feel free to fork this guide and see how I've written it too! 😄🙌🏻
Now go and have fun creating your Github profile and start adding projects!
If you like this guide, please give this repo a Star 🌟 Happy GitHub-ing! 🙆🏻♀️