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#

FeatureUser SiteOrganization SiteProject Site
Primary IntentPersonal portfolio, resume, or central hub.Brand, company, or collective identity.Documentation or landing page for a specific repo.
Repo Namingusername.github.ioorgname.github.ioany-repo-name
Default URLhttps://username.github.iohttps://orgname.github.iohttps://username.github.io/repo/
Apex DomainSupported (e.g., domain.com).Supported (e.g., company.com).Supported (e.g., project.com).
SubdomainSupported (e.g., user.domain.com).Supported (e.g., org.domain.com).Supported (e.g., docs.domain.com).
CapacityOne (1) per account.One (1) per organization.Unlimited per account/org.
PermissionsIndividual 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.