peaceiris/actions-gh-pages

Health v2 · maintenance only

Adoption not part of the score

5357 stars · 451 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-29, confidence not recorded

A GitHub Action that deploys static files to GitHub Pages, publishing a directory to the gh-pages branch from CI workflows. It works with any static site generator such as Hugo, MkDocs, Gatsby, mdBook, Next.js, and Nuxt.

Use cases

• deploy a static site to github pages from ci
• publish hugo site automatically on push
• deploy mkdocs documentation with github actions
• publish gatsby build output to gh-pages branch
• automate static site deployment without manual steps
• deploy next.js or nuxt static export to github pages

When to choose

• you deploy static sites or docs to GitHub Pages from GitHub Actions
• you want zero-setup deployment using the built-in GITHUB_TOKEN
• you need SSH deploy key or personal token support for private repos
• you use any static site generator and just want to publish a build directory

When to avoid

• you host on Netlify, Vercel, or another platform instead of GitHub Pages
• you need server-side rendering or dynamic hosting rather than static files
• GitHub's official Pages deploy action already covers your simple workflow

Facets

plugin · maturity stable

deployment ci-cd static-site-generator web-development documentation windows cloud github-actions github-pages static-site-deployment hugo mkdocs gatsby jamstack devops automation linux macos

Member repositories

For agents

markdown · JSON · MCP: product_card(name="peaceiris/actions-gh-pages")