Pages Help

Websites for you and your projects.

Hosted directly from your GitHub repository. Just edit, push, and your changes are live.

Image 1
Image 2
Image 3
Image 4
Image 5
Image 6
Image 7
Image 8
Image 9
Image 10
Image 11

1

Create a repository

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

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

github image

1.5

What git client are you using?

2

Clone the repository

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

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

gudie img

3

Create an index file

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

<!DOCTYPE html>

<html>

<body>

<h1>Hello World</h1>

<p>I'm hosted with GitHub Pages.</p>

</body>

</html>

4

Commit & publish

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

example

5

…and you're done!

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

done gif

Now that you’re up and running, here are a few things you should know.

Blogging with Jekyll

Using Jekyll, you can blog using beautiful Markdown syntax, and without having to deal with any databases. Learn how to set up Jekyll.

Custom URLs

Want to use your own custom domain for a GitHub Pages site? Just create a file named CNAME and include your URL. Read more.

Guides

Learn how to create custom 404 pages, use submodules, and learn more about GitHub Pages.