* Replace autolink-references-tab.png with octicon * Create reusable and version for manage-access-tab.png * Replace repo-settings-interaction-limits.png with octicon * Delete repo-settings-moderation-settings.png * Replace repo-settings-reported-content.png with octicon * Version repository-branches reusable * Update and version navigate-to-security-and-analysis reusable * Update sidebar-pages reusable (and add to pages quickstart) * Version dependabot-secrets-button reusable and delete unused image * Update pages octicon * Fix typo in reusable name * Versioning fixes * Use consistent sidebar terminology * More clearly describe sections of settings sidebar
3.5 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
{% data variables.product.prodname_pages %} are public webpages hosted and published through {% data variables.product.product_name %}. The quickest way to get up and running is by using the Jekyll Theme Chooser to load a pre-made theme. You can then modify your {% data variables.product.prodname_pages %}' content and style.
This guide will lead you through creating 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.sidebar-settings %}
{% data reusables.pages.sidebar-pages %} - Click Choose a theme.

- The Theme Chooser will open. Browse the available themes, then click Select theme to select a theme. It's easy to change your theme later, so if you're not sure, just choose one for now.

- After you select a theme, your repository's
README.mdfile will open in the file editor. TheREADME.mdfile is where you will write the content for your site. You can edit the file or keep the default content for now. - When you are done editing the file, click Commit changes.
- Visit
username.github.ioto view your new website. Note: It can take up to 20 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}.
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 done editing the file, click Commit changes.
Next Steps
For more information about how to add additional pages to your site, see "Adding content to your GitHub Pages site using Jekyll."
For more information about setting up a {% data variables.product.prodname_pages %} site with Jekyll, see "About GitHub Pages and Jekyll."