Quickstart for GitHub Pages
You can use GitHub Pages to showcase some open source projects, host a blog, or even share your résumé. This guide will help get you started on creating your next website.
Who can use this feature?
GitHub Pages is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, seeGitHub’s plans.
Introduction
In this guide, you'll create a user site at<username>.github.io.
Creating your website
In the upper-right corner of any page, select, then clickNew repository.

Enter
username.github.ioas the repository name. Replaceusernamewith your GitHub username. For example, if your username isoctocat, the repository name should beoctocat.github.io.
Choose a repository visibility. For more information, seeAbout repositories.
ToggleAdd README toOn.
ClickCreate repository.
Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then clickSettings.

In the "Code and automation" section of the sidebar, click Pages.
Under "Build and deployment", under "Source", selectDeploy from a branch.
Under "Build and deployment", under "Branch", use the branch dropdown menu and select a publishing source.

Optionally, open the
README.mdfile of your repository. TheREADME.mdfile is where you will write the content for your site. You can edit the file or keep the default content for now.Visit
username.github.ioto view your new website. Note that it can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub.
Changing the title and description
By default, the title of your site isusername.github.io. You can change the title by editing the_config.yml file in your repository. You can also add a description for your site.
Click theCode tab of your repository.
In the file list, click
_config.ymlto open the file.Click to edit the file.
The
_config.ymlfile already contains a line that specifies the theme for your site. Add a new line withtitle:followed by the title you want. Add a new line withdescription:followed by the description you want. For example:theme:jekyll-theme-minimaltitle:Octocat'shomepagedescription:Bookmarkthistokeepaneyeonmyprojectupdates!When you are finished editing the file, clickCommit changes.
Next Steps
You've successfully created, personalized, and published your first GitHub Pages website but there's so much more to explore! Here are some helpful resources for taking your next steps with GitHub Pages:
- Adding content to your GitHub Pages site using Jekyll: This guide explains how to add additional pages to your site.
- Configuring a custom domain for your GitHub Pages site: You can host your site on GitHub's
github.iodomain or your own custom domain.