topskills
Browse Skills

Guide

Deploy a static site to GitHub Pages with an AI agent

To deploy a static site to GitHub Pages from chat, install the github-pages Skill and ask your agent to publish. It enables Pages on the repo, generates the right GitHub Actions build workflow, supports Jekyll, and configures a custom domain (apex + CNAME). GitHub Pages hosting is free for public repos.

It is a community Skill (MIT) from julianobarbosa/claude-code-skills, with separate workflows for QuickStart, custom domains, Jekyll, Actions, and troubleshooting. Best for docs, portfolios, and project sites that live in a GitHub repo.

Install

Add the Skill

Full editorial entry, composite score, and license on the github-pages page.

Claude Code

/plugin marketplace add julianobarbosa/claude-code-skills

Then install the github-pages skill, or copy skills/github-pages into your .claude/skills directory.

Step by step

Deploy from chat

  1. 1

    Have a static build in a repo

    GitHub Pages serves static output. Make sure your site builds to static files (HTML/CSS/JS, or a Jekyll/Astro/Vite build) and lives in a GitHub repository.

  2. 2

    Install the Skill

    Add the marketplace and install the github-pages skill with the command above. The Skill ships six workflows — QuickStart, CustomDomain, JekyllSetup, ActionsWorkflow, Troubleshoot, and Deploy.

  3. 3

    Enable Pages and generate the Actions workflow

    Ask the agent to set up GitHub Pages. The Skill enables Pages on the repo and writes a GitHub Actions workflow matched to your project type, so every push to the default branch rebuilds and republishes.

  4. 4

    Add a custom domain (optional)

    For a custom domain, the Skill's CustomDomain workflow handles both apex (example.com) and subdomain (www.example.com) setup, including the CNAME file and the DNS records you need to add.

  5. 5

    Verify the live URL

    The site goes live at https://<username>.github.io/<repo> (project site) or https://<username>.github.io (user/org site). If something fails, the Troubleshoot workflow diagnoses common Pages build errors.

Site types

GitHub Pages URL patterns

Site typeRepo nameURL
User / Org site<username>.github.iohttps://<username>.github.io
Project siteany repo namehttps://<username>.github.io/<repo>

Public repos get Pages on every GitHub plan. Private-repo Pages requires GitHub Pro, Team, or Enterprise.

FAQ

Common questions

Is GitHub Pages hosting free?

Yes for public repositories on every GitHub plan. The github-pages Skill is also free and open-source (MIT). Private-repo Pages requires a paid GitHub plan (Pro, Team, or Enterprise).

Can the Skill set up a custom domain?

Yes. Its CustomDomain workflow handles both apex and subdomain domains, writes the CNAME file, and tells you the exact DNS records to add at your registrar.

Does it support Jekyll?

Yes — there is a dedicated JekyllSetup workflow for adding a Jekyll theme, and the Skill generates an Actions workflow that builds Jekyll (or any static generator) on push.

Can it deploy a server-rendered app?

No. GitHub Pages serves static files only. For server-rendered apps or serverless functions, use Vercel, Netlify, Cloudflare, or Firebase instead — see the main deploy guide for the per-host picks.

Related

More deploy guides

Browse the full category: Web Hosting & Deploys Skills.