Skip to content

Introduction

are public webpages hosted and published through . 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 ' content and style.

This guide will lead you through creating a user site at username.github.io.

Creating your website

  1. Enter username.github.io as the repository name. Replace username with your username. For example, if your username is octocat, the repository name should be octocat.github.io. ![Screenshot of settings in a repository. The repository name field contains the text "octocat.github.io" and is outlined in dark orange.]

  2. Under "Build and deployment", under "Source", select Deploy from a branch.

  3. Under "Build and deployment", under "Branch", use the branch dropdown menu and select a publishing source. ![Screenshot of Pages settings in a repository. A menu to select a branch for a publishing source, labeled "None," is outlined in dark orange.]

  4. Optionally, open the README.md file of your repository. The README.md file is where you will write the content for your site. You can edit the file or keep the default content for now.

  5. Visit username.github.io to 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 .

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.

  1. Click the Code tab of your repository.

  2. In the file list, click _config.yml to open the file.

  3. Click to edit the file.

  4. The _config.yml file already contains a line that specifies the theme for your site. Add a new line with title: followed by the title you want. Add a new line with description: followed by the description you want. For example:

    yaml
    theme: jekyll-theme-minimal
    title: Octocat's homepage
    description: Bookmark this to keep an eye on my project updates!
  5. 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 "AUTOTITLE."

For more information about setting up a site with Jekyll, see "AUTOTITLE."

Released under the MIT License. (dev)