3.7 KiB
title, intro, allowTitleToDifferFromFilename, versions, type, topics, shortTitle, product
| title | intro | allowTitleToDifferFromFilename | versions | type | topics | shortTitle | product | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Quickstart for GitHub Pages | You can use {% data variables.product.prodname_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. | true |
|
quick_start |
|
Quickstart | {% data reusables.gated-features.pages %} |
Introduction
In this guide, you'll create a user site at <username>.github.io.
Creating your website
{% data reusables.repositories.create_new %}
- Enter
username.github.ioas the repository name. Replaceusernamewith your {% data variables.product.prodname_dotcom %} username. For example, if your username isoctocat, the repository name should beoctocat.github.io.
{% data reusables.repositories.choose-repo-visibility %}
{% data reusables.repositories.initialize-with-readme %}
{% data reusables.repositories.create-repo %}
{% data reusables.repositories.sidebar-settings %}
{% data reusables.pages.sidebar-pages %} - Under "Build and deployment", under "Source", select Deploy 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 {% data variables.product.github %}.
Changing the title and description
By default, the title of your site is username.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 the Code tab of your repository.
-
In the file list, click
_config.ymlto open the file. -
Click {% octicon "pencil" aria-label="The edit icon" %} 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-minimal title: Octocat's homepage description: Bookmark this to keep an eye on my project updates! -
When you are finished editing the file, click Commit changes.
Next Steps
You've successfully created, personalized, and published your first {% data variables.product.prodname_pages %} website but there's so much more to explore! Here are some helpful resources for taking your next steps with {% data variables.product.prodname_pages %}: