Skip to content

docs: Correct GitHub Pages setup instructions #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
attogram merged 1 commit into from
Aug 28, 2025
Merged

docs: Correct GitHub Pages setup instructions #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
uses: actions/configure-pages@v5
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
Expand Down
12 changes: 12 additions & 0 deletions docs/github-pages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

This repository is configured to use [GitHub Pages](https://pages.github.com/) to host a simple, clean website for the project.

## Initial Setup

Before the workflow can deploy your site, you must configure your repository to use GitHub Actions for GitHub Pages. This is a one-time setup step that connects your repository's Pages settings to the `pages.yml` workflow included in this template.

1. **Navigate to Repository Settings:** Go to the main page of your repository and click on the **Settings** tab.
2. **Select Pages:** In the left-hand sidebar, click on **Pages**.
3. **Set the Deployment Source:** Under the "Build and deployment" section, you will see a **Source** option. Select **"GitHub Actions"** from the dropdown menu.

After you select "GitHub Actions", the UI may present you with suggestions for common workflows (e.g., "GitHub Pages Jekyll", "Static HTML"). **You can ignore these suggestions.** This repository already contains a custom, pre-configured workflow (`.github/workflows/pages.yml`) that will be used automatically.

> **Note:** If you do not perform this setup step, the `pages.yml` workflow will fail with a "Get Pages site failed" or "HttpError: Not Found" error.

## How It Works

The site is built and deployed by the `.github/workflows/pages.yml` workflow. Here's a summary of the process:
Expand Down