Sign in Subscribe
Git

Creating a Custom GitHub Profile Page

A step by step on creating a GitHub profile page using Markdown text formatting.

Robert Mizen

• 4 min read
Creating a Custom GitHub Profile Page

Creating a GitHub profile page with a README.md file is a great way to introduce yourself and showcase your work. I will explain and also provide a nice example of a simple README.md you are free to use.

Sign Up or Log In to GitHub:


If you don't have a GitHub account, you'll need to sign up. If you already have an account, log in.

Create a New Repository:

  1. Click on the "+" sign at the top right corner and select "New repository."
  1. Name your repository with the name that is your GitHub username. For example, if your username is "robert-mizen," the repository name should be "robert-mizen"
  2. You should choose to make this repository public, as it's required for hosting your profile. (At time of writing)

Initialise the Repository with a README:

  1. During the repository creation process, you'll be asked to initialise the repository with a README file. Check the "Add a README file" checkbox. You will need this to have a file that will be editable and usable by GitHub to display the information in it.

Create or Edit Your README.md:

  1. You can create or edit your README.md file directly on the GitHub website.
  2. Click on the README.md file in your repository, and then click the pencil (edit) icon to make changes.
  1. Use the template provided (at the bottom of this page) or create your own content to introduce yourself, showcase your work, and share relevant information. The format of the README.md is Markdown, which is a very universal format across web, software and services. Markdown Guide

Commit Changes:

  1. After making your changes to the README.md file, scroll down and provide a brief description of the changes you made in the "Commit changes" section.
  2. Click the "Commit changes" button to save your README.md file.

Set Repository to Public:

  1. In the repository settings, make sure your repository is set to "Public." Private repositories won't work for hosting your GitHub profile.

Access Your GitHub Profile:

  1. Your GitHub profile is now accessible at https://github.com/<your-username>, where <your-username> is your GitHub username. For example, if your username is "robert-mizen," your profile URL would be https://github.com/robert-mizen.

Custom Domain (Optional):

  1. If you want to use a custom domain for your GitHub profile (e.g., yourname.com), you can do so by configuring the necessary DNS settings and adding a CNAME file to your repository. This is not covered in this guide as its focus is for beginners.

Explore and Update:

  1. Regularly update your README.md to reflect your latest work, projects, or information about yourself.
  2. Customise your GitHub profile by adding more repositories, pinned projects, or a profile picture.

That's it! You now have a GitHub profile with a README.md file. You can use this space to showcase your work, provide information about yourself, and engage with the GitHub community.

Profile Example Template:

Copy and paste the below text in to your README.md file in GitHub or your editor of choice. The template text below is actually Markdown format text. So you can copy and paste this in GitHub and it should look just like this 😎

I'm [Your Name], I work as a [Your Role/Title] i love [Your Interests]. Welcome to my GitHub profile!

About Me

  • 🌱 I'm currently learning [What you're learning].
  • 💼 I work at [Where you work].
  • 📫 You can reach me at [Your Email] or [Your Website].

My Projects

Here are some of the projects I've been working on:

  1. Project 1: Brief description.
  2. Project 2: Brief description.
  3. Project 3: Brief description.

Skills

  • [Skill 1]
  • [Skill 2]
  • [Skill 3]
  • ...

Connect with Me

Feel free to explore my repositories, and don't hesitate to reach out if you have any questions or collaboration ideas!

Visitor Count