Ready to get started? Build your own site
from scratch or generate one for your
project.

You get one site per GitHub account and organization,
and unlimited project sites. Let‘s get started.

• 1

  Create a repository

  Head over to GitHub and create a new repository named username.github.io, where username is your username (or organization name) on GitHub.

  If the first part of the repository doesn’t exactly match your username, it won’t work, so make sure to get it right.

  
• ?

  What git client are you using?

  A terminal GitHub Desktop I don't know
2

Clone the repository

Go to the folder where you want to store your project, and clone the new repository:



3

Hello World

Enter the project folder and add an index.html file:



4

Push it

Add, commit, and push your changes:



5

…and you're done!

Fire up a browser and go to https://username.github.io.

2

Clone the repository

Click the "Set up in Desktop" button. When the GitHub desktop app opens, save the project.

If the app doesn't open, launch it and clone the repository from the app.



3

Create an index file

Grab your favorite text editor and add an index.html file to your project:



4

Commit & publish

Enter the repository, commit your changes, and press the publish button.



5

…and you're done!

Fire up a browser and go to https://username.github.io.

2

Download GitHub Desktop

GitHub Desktop is a great way to use Git and GitHub on macOS and Windows.

Download GitHub Desktop



3

Clone the repository

Click the "Set up in Desktop" button. When the GitHub desktop app opens, save the project.

If the app doesn't open, launch it and clone the repository from the app.



4

Create an index file

Grab your favorite text editor and add an index.html file to your project:



5

Commit & publish

Enter the repository, commit your changes, and press the publish button.



6

…and you're done!

Fire up a browser and go to https://username.github.io.

• ?

  Use a theme, or start from scratch?

  You have the option to start with one of the pre-built themes,
  or to create a site from scratch.

  Choose a theme Start from scratch
1

Repository Settings

Head over to GitHub.com and create a new repository, or go to an existing one.
Click on the Settings tab.



2

Theme chooser

Scroll down to the GitHub Pages section. Press Choose a theme.



3

Pick a theme

Choose one of the themes from the carousel at the top.
When you're done, click Select theme on the right.



4

Edit content

Use the editor to add content to your site.



5

Commit

Enter a commit comment and click on Commit changes below the editor.



6

…and you're done!

Fire up a browser and go to https://username.github.io/repository.

1

Create an index file

Head over to GitHub.com and create a new repository, or go to an existing one.
Click on the Create new file button.



2

Hello World

Name the file index.html and type some HTML content into the editor.



3

Commit the file

Scroll to the bottom of the page, write a commit message, and commit the new file.



4

Repository Settings

Click on the Settings tab and scroll down to the GitHub Pages section.
Then select the master branch source and click on the Save button.



5

…and you're done!

Fire up a browser and go to https://username.github.io/repository.