Skip to content

Commit 5e1745a

Browse files
committed
Add comprehensive deployment documentation
- Replace outdated release section with detailed deployment guide - Add step-by-step manual deployment instructions for GitHub Actions workflow - Include prerequisites, repository settings, and troubleshooting section - Document GitHub Pages configuration and workflow permissions
1 parent ed75ffa commit 5e1745a

1 file changed

Lines changed: 33 additions & 4 deletions

File tree

README.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,39 @@ Whatever is good for a simple, easy to maintain and modern static webpages
4949
html, css, javascript.
5050
Just keep it simple with as little code and dependencies as possible, but try to keep it modern and convenient.
5151

52-
## Release
53-
> **Note:** GitHub Pages deployment workflow needs to be configured by repository administrators with appropriate permissions.
54-
55-
The static website can be deployed to GitHub Pages. A GitHub Actions workflow file is included in the repository for automatic deployment when pushing to the `main` branch.
52+
## Deployment
53+
54+
### Manual Deployment to GitHub Pages
55+
The repository includes a GitHub Actions workflow for manual deployment to the `gh-pages` branch.
56+
57+
#### Prerequisites
58+
- Repository administrator permissions
59+
- GitHub Actions enabled for the repository
60+
- GitHub Pages configured to deploy from `gh-pages` branch
61+
62+
#### How to Deploy
63+
1. **Navigate to the Actions tab** in your GitHub repository
64+
2. **Select "Deploy to GitHub Pages"** workflow
65+
3. **Click "Run workflow"** button
66+
4. **Choose environment** (production/staging) - optional
67+
5. **Click "Run workflow"** to start deployment
68+
69+
The workflow will automatically:
70+
- Build the static site (cleanup development files)
71+
- Create/update the `gh-pages` branch
72+
- Deploy to GitHub Pages
73+
74+
#### Repository Settings
75+
Ensure GitHub Pages is configured in repository settings:
76+
- Go to **Settings → Pages**
77+
- Set **Source** to "Deploy from a branch"
78+
- Select **Branch**: `gh-pages` and **Folder**: `/ (root)`
79+
80+
#### Troubleshooting
81+
If you encounter workflow permission errors:
82+
- Ensure your GitHub token has `workflow` scope permissions
83+
- Repository administrators may need to enable GitHub Actions
84+
- Check that GitHub Pages is enabled in repository settings
5685

5786
## Local Development
5887
To run the website locally:

0 commit comments

Comments
 (0)