fix: docs Pages deploy permissions and document GitHub Pages setup

Deploy job failed because Pages source must be GitHub Actions; document
About/description guidance and fix workflow job permissions.
This commit is contained in:
O96u committed 2026-08-29 11:53:20 +08:00
1 parent 9b0a3f4944
commit 58a8e2082f
5 files changed
+53

No files matched your search

+12
View File
@@ -52,3 +52,15 @@ npm run docs:preview # 预览构建结果
```
文档源码在 `docs-site/`;截图源文件在 `docs/screenshots/`(含 `login.png` 登录页),构建前会复制到 `docs-site/public/screenshots/`。
## 发布到 GitHub Pages
在线文档地址:<https://o96u.github.io/PicHost/>
**首次启用**(部署 job 失败、访问 404 时检查):
1. 仓库 **Settings → Pages**
2. **Build and deployment → Source** 选择 **GitHub Actions**(不要选 Deploy from a branch)
3. 推送 `main` 触发 `docs` workflow,或在 Actions 页手动 **Run workflow**
构建成功后约 1–2 分钟可访问。`docs` workflow 的 `deploy` 步骤失败且日志提示 Pages 未启用时,多为未完成上述设置。