Github Pages

Static content hosting with GitHub Pages#

Let’s review the nuances between site types and how to automate their deployment.

GitHub Pages Site Types#

Feature User Site Organization Site Project Site
Primary Intent Personal portfolio, resume, or central hub. Brand, company, or collective identity. Documentation or landing page for a specific repo.
Repo Naming username.github.io orgname.github.io any-repo-name
Default URL https://username.github.io https://orgname.github.io https://username.github.io/repo/
Apex Domain Supported (e.g., domain.com). Supported (e.g., company.com). Supported (e.g., project.com).
Subdomain Supported (e.g., user.domain.com). Supported (e.g., org.domain.com). Supported (e.g., docs.domain.com).
Capacity One (1) per account. One (1) per organization. Unlimited per account/org.
Permissions Individual ownership. Shared team administrative access. Inherited from the project repository.

Deployment Workflow Strategies#

Static site generators (SSGs) like Hugo or MkDocs require a build step to turn source files into HTML. How you handle that build defines your workflow.