Skip to content

Commit 5b01009

Browse files
authored
Merge pull request #4 from attogram/docs-correct-github-pages-setup
docs: Correct GitHub Pages setup instructions
2 parents b1386bf + 0d98175 commit 5b01009

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

.github/workflows/pages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
- name: Checkout
2929
uses: actions/checkout@v4
3030
- name: Setup Pages
31-
uses: actions/configure-pages@v4
31+
uses: actions/configure-pages@v5
3232
- name: Build with Jekyll
3333
uses: actions/jekyll-build-pages@v1
3434
with:

docs/github-pages.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

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

5+
## Initial Setup
6+
7+
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.
8+
9+
1. **Navigate to Repository Settings:** Go to the main page of your repository and click on the **Settings** tab.
10+
2. **Select Pages:** In the left-hand sidebar, click on **Pages**.
11+
3. **Set the Deployment Source:** Under the "Build and deployment" section, you will see a **Source** option. Select **"GitHub Actions"** from the dropdown menu.
12+
13+
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.
14+
15+
> **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.
16+
517
## How It Works
618

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

0 commit comments

Comments
 (0)