GitHub Pages

What Are And How to use gh-pages

Kent C. Dodds

Marvel Random

Building a sweet library with the Marvel API

Write the Library

Add A Build

Make a Demo

Enter gh-pages

What are GH-Pages

"Websites for you and your projects. Hosted directly from your GitHub repository. Just edit, push, and your changes are live." -


"Jekyll is a blog-aware, static site generator in Ruby" -

How To Use gh-pages

- Users / Organizations: It's all about the repo name
- Projects: It's all about the gh-pages branch

User/Org PageS

1. Create a repo called <username>
2. Push code master branch
3. Boom! Static files hosted!


Project Pages

1. Create a repo called <whatever>

2. Push code to gh-pages branch

3. Boom! Static files hosted!


Create gh-pages Branch

Add GH-Pages to Build

Custom Domains

1. Create a file (in the repo root) called "CNAME"
2. Add one line that's your domain
3. Setup your DNS to forward properly

That's it!
Works with user/orgs and projects

Working With Backends

2. Custom

That's it!



Kent C. Dodds


By Kent C. Dodds


What are and how to use github pages

  • 2,624
Loading comments...

More from Kent C. Dodds