Websites for you and your projects.
Hosted directly from your GitHub repository. Just edit, push, and your changes are live.
Pages Help
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.
GitHub for Windows is a great way to use git and GitHub on Windows.
Download GitHub for Windows
GitHub for Mac is a great way to use git and GitHub on Mac.
Download GitHub for Mac
Go to the folder where you want to store your project, and clone the new repository:
~$git clone https://github.com/username/username.github.io
Click the green "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.
After finishing the installation, head back to GitHub.com and refresh the page. Click the green "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.
Enter the project folder and add an index.html file:
~$cd username.github.io
~$echo "Hello World" > index.html
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>
Add, commit, and push your changes:
~$git add --all
~$git commit -m "Initial commit"
~$git push -u origin master
Enter the repository, commit your changes, and press the sync button.
Enter the repository, commit your changes, and press the sync button.
Fire up a browser and go to http://username.github.io.
For Project sites, you have the option to generate a site with one of the amazing pre-built themes, or to create a site from scratch.
Head over to GitHub.com and create a new repository, or go to an existing one. Click on the Settings tab.
For Project pages, the gh-pages branch is used to publish your site. That means that you can work with GitHub Pages in the same repository as the project that it's for, without affecting the project itself.
Scroll down to the GitHub Pages module. Press the Launch automatic page generator button.
Use the editor to add content to your site. If you already have a README.md in your project, you can import that on the right hand side.
When you're done, click Continue to Layouts.
Choose between the themes in the carouselle at the top. When you're done, click the Publish button on the right hand side.
Head over to GitHub.com and create a new repository, or go to an existing one. In the repository overview, click the branch drop-down on the left-hand side. Type in gh-pages and press enter.
For Project pages, the gh-pages branch is used to publish your site. That means that you can work with GitHub Pages in the same repository as the project that it's for.
If you created a new branch for GitHub Pages, go to the repository settings. In the Branches section, change the default branch to the newly created gh-pages branch.
Go back to the repository overview, and use the plus icon next to the repository name to create a new file.
Name the file index.html and type in Hello World for the content.
Scroll to the bottom of the page, write a commit message, and commit the new file.
Fire up a browser and go to http://username.github.io/repository.