Skip to content

Commit 8c60faa

Browse files
committed
docs: 创建GitHub Pages部署说明文档
📝 新增文件: - DEPLOYMENT_INSTRUCTIONS.md - 详细的部署操作指南 - 启用GitHub Pages的步骤 - 等待部署完成的说明 - 故障排除指南 - 网站访问地址 📋 包含的信息: 1. GitHub仓库设置步骤(Settings > Pages > GitHub Actions) 2. 部署完成后的访问地址 3. 网站功能说明 4. 常见问题解决方案 5. 后续更新流程 💡 指导用户: - 设置GitHub Pages(需要手动在仓库设置中启用) - 等待GitHub Actions工作流完成 - 访问网站:https://shiying-zhang.github.io/diffusion-theory-discussion/ 🚀 完成状态: - 代码已推送到GitHub - GitHub Actions工作流已创建 - 等待用户启用GitHub Pages即可上线!
1 parent 8ed9b57 commit 8c60faa

File tree

1 file changed

+110
-0
lines changed

1 file changed

+110
-0
lines changed

DEPLOYMENT_INSTRUCTIONS.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# 🚀 GitHub Pages 部署说明
2+
3+
## ✅ 已完成的工作
4+
5+
1. **修复连线问题** - interactive chart中的论文连线现在精确连接圆圈边缘
6+
2. **GitHub Actions自动部署** - 代码已推送到GitHub,工作流将自动运行
7+
3. **完整文档** - 创建了部署指南和说明文档
8+
9+
## 📋 下一步操作(手动完成)
10+
11+
由于GitHub Pages需要在仓库设置中启用,请按以下步骤操作:
12+
13+
### 第一步:启用GitHub Pages
14+
15+
1. 打开您的GitHub仓库:https://github.com/Shiying-Zhang/diffusion-theory-discussion
16+
2. 点击顶部的 **Settings** 标签
17+
3. 在左侧菜单中找到 **Pages**
18+
4. 在 "Source" 部分,选择 **"GitHub Actions"**
19+
- 注意:不是选择 "Deploy from a branch",而是选择 "GitHub Actions"
20+
21+
### 第二步:等待部署完成
22+
23+
1. 前往 **Actions** 标签页
24+
2. 应该能看到一个名为 "Deploy to GitHub Pages" 的工作流正在运行或已完成
25+
3. 等待工作流完成(通常需要1-2分钟)
26+
27+
### 第三步:访问网站
28+
29+
部署完成后,网站将在以下地址可用:
30+
**https://shiying-zhang.github.io/diffusion-theory-discussion/**
31+
32+
## 📊 网站结构
33+
34+
部署后的网站将包含:
35+
36+
### 主页面
37+
- **Interactive Theory Chart** - 交互式论文网络图
38+
- 上半部分:论文关系网络(8篇核心论文)
39+
- 下半部分:Diffusion理论变量定义
40+
- 悬停高亮效果
41+
42+
### 其他页面
43+
- **Papers**: https://shiying-zhang.github.io/diffusion-theory-discussion/papers.html
44+
- **Issues**: https://shiying-zhang.github.io/diffusion-theory-discussion/issues.html
45+
- **Notes**: 通过导航链接访问
46+
47+
## 🔧 故障排除
48+
49+
### 如果GitHub Pages没有启用
50+
51+
1. 确保在Settings > Pages中选择了"GitHub Actions"而不是"Deploy from a branch"
52+
2. 等待几分钟让更改生效
53+
3. 尝试访问网站 URL
54+
55+
### 如果部署失败
56+
57+
1. 检查 **Actions** 标签页查看错误信息
58+
2. 常见错误:
59+
- 文件路径问题 - 确保所有文件在 `website/` 目录中
60+
- HTML语法错误 - 检查文件是否有语法错误
61+
62+
### 如果页面显示404
63+
64+
1. 确保URL完整:https://shiying-zhang.github.io/diffusion-theory-discussion/index.html
65+
2. 等待最多10分钟让部署完全生效
66+
3. 清除浏览器缓存并硬刷新 (Ctrl+F5 或 Cmd+Shift+R)
67+
68+
## 📝 网站功能
69+
70+
### 1. 交互式理论图表
71+
- 鼠标悬停查看论文关系
72+
- 颜色编码显示论文类型
73+
- 变量定义区域显示8个关键概念
74+
75+
### 2. 论文阅读列表
76+
- 11篇核心论文的卡片式展示
77+
- 3条推荐阅读路径
78+
- 状态追踪(已完成/阅读中/未读)
79+
80+
### 3. Issues可视化
81+
- 实时显示GitHub仓库Issues
82+
- 按类型过滤
83+
- 一键跳转到GitHub
84+
85+
### 4. Notes集成
86+
- 链接到DDPM和Score-based SDE笔记
87+
- 所有页面都有快速访问链接
88+
89+
## 🔄 后续更新
90+
91+
以后要更新网站内容时:
92+
93+
1. 编辑 `website/` 目录中的文件
94+
2. 提交并推送到 `main` 分支
95+
3. GitHub Actions会自动部署更新
96+
4. 等待1-2分钟让更改生效
97+
98+
## 📞 需要帮助?
99+
100+
如果遇到问题:
101+
102+
1. 查看 **GITHUB_PAGES.md** 获取详细指南
103+
2. 查看仓库的 **Actions** 标签页查看部署日志
104+
3. 在GitHub上创建Issue讨论问题
105+
106+
---
107+
108+
**部署完成后,请访问:https://shiying-zhang.github.io/diffusion-theory-discussion/**
109+
110+
🎉 享受您的交互式扩散模型理论网站!

0 commit comments

Comments
 (0)