GitHub Pages Configuration Guide

Source: This guide is derived from the official GitHub Pages documentation

Overview

GitHub Pages hosts static websites from your repository using two deployment methods:

  1. Deploy from Branch: Simple, limited to root or /docs folder
  2. GitHub Actions: Flexible, custom build processes (recommended)

Configuration Steps

Method 1: Traditional Deployment

  1. Navigate to Repository Settings

    • Go to your repository on GitHub
    • Click “Settings” tab
    • Scroll to “Pages” section
  2. Configure Source

    • Source: “Deploy from a branch”
    • Branch: Select your branch (e.g., main, v4)
    • Folder: Choose / (root) or /docs
    • Click “Save”
  3. Access Your Site

    • URL: https://username.github.io/repository-name/
    • Build time: Usually 1-5 minutes

Method 2: GitHub Actions

  1. Enable GitHub Actions
    • Repository Settings → Pages
    • Source: “GitHub Actions”
    • Use GitHub’s suggested workflow templates for your framework

Manual Deployment

npx quartz build && cp -r public/* . && git add . && git commit -m "Deploy site" && git push

Resources


This guide was created during Phase 4.1 of the microsite deployment process as a reference for GitHub Pages configuration options.