排版优化

Author: beihaili

DEPLOYMENT_README.md

@@ -5,21 +5,21 @@
 ## ✨ 新特性
 
 ### 🔐 安全的 API 密钥管理
-- 使用 GitHub Secrets 安全存储 Gemini API Key
-- 支持环境变量配置
-- 前端不再硬编码敏感信息
+- 使用 GitHub Secrets 安全存储 Gemini API Key 。
+- 支持环境变量配置。
+- 前端不再硬编码敏感信息。
 
 ### 🤖 自动化部署流程
-- 推送到 main 分支自动部署
-- Pull Request 自动构建预览
-- 部署成功/失败通知
-- 无需手动运行部署命令
+- 推送到 main 分支自动部署。
+- Pull Request 自动构建预览。
+- 部署成功 / 失败通知。
+- 无需手动运行部署命令。
 
 ### 🎯 优化的开发体验
-- 本地开发使用 `.env.local`
-- 生产环境使用 GitHub Secrets
-- 热重载开发服务器
-- 统一的构建流程
+- 本地开发使用 `.env.local` 。
+- 生产环境使用 GitHub Secrets 。
+- 热重载开发服务器。
+- 统一的构建流程。
 
 ## 📦 快速开始
 
@@ -36,15 +36,14 @@ npm install
 # 配置环境变量
 cp .env.example .env.local
 # 编辑 .env.local 并添加你的 Gemini API Key
-
 # 启动开发服务器
 npm run dev
 ```
 
 ### 2. 生产环境部署
 
 1. **配置 GitHub Secrets**（必需）
-   - 按照 [GITHUB_SECRETS_SETUP.md](./GITHUB_SECRETS_SETUP.md) 配置
+   - 按照 [GITHUB_SECRETS_SETUP.md](./GITHUB_SECRETS_SETUP.md) 配置。
 
 2. **推送代码自动部署**
    ```bash
@@ -85,11 +84,11 @@ GetStartedWithWeb3/
 
 ### 自动部署（推荐）
 
-1. **推送触发**：推送到 main 分支
-2. **环境准备**：GitHub Actions 设置 Node.js 环境
-3. **依赖安装**：自动安装项目依赖
-4. **应用构建**：使用 Secrets 中的环境变量构建
-5. **部署上线**：自动部署到 GitHub Pages
+1. **推送触发**：推送到 main 分支。
+2. **环境准备**： GitHub Actions 设置 Node.js 环境。
+3. **依赖安装**：自动安装项目依赖。
+4. **应用构建**：使用 Secrets 中的环境变量构建。
+5. **部署上线**：自动部署到 GitHub Pages 。
 
 ### 手动部署（备用）
 
@@ -99,34 +98,34 @@ npm run deploy
 
 ## 🌐 访问地址
 
-- **生产环境**：https://beihaili.github.io/GetStartedWithWeb3/
-- **开发环境**：http://localhost:5173/GetStartedWithWeb3/
+- **生产环境**： https://beihaili.github.io/GetStartedWithWeb3/
+- **开发环境**： http://localhost:5173/GetStartedWithWeb3/
 
 ## 📱 功能特性
 
 ### 🎨 用户界面
-- 赛博朋克风格设计
-- 响应式布局
-- 深色主题
-- 霓虹效果和动画
+- 赛博朋克风格设计。
+- 响应式布局。
+- 深色主题。
+- 霓虹效果和动画。
 
 ### 🔗 Web3 功能
-- 钱包连接模拟
-- 链上进度存储
-- Web3 每日预言机
-- 哈希可视化工具
+- 钱包连接模拟。
+- 链上进度存储。
+- Web3 每日预言机。
+- 哈希可视化工具。
 
 ### 🤖 AI 助手
-- Gemini AI 智能问答
-- 自动生成测验
-- 个性化学习建议
-- 上下文相关帮助
+- Gemini AI 智能问答。
+- 自动生成测验。
+- 个性化学习建议。
+- 上下文相关帮助。
 
 ### 📚 内容管理
-- 从 GitHub 动态加载教程
-- Markdown 渲染
-- 图片自动处理
-- 多语言支持
+- 从 GitHub 动态加载教程。
+- Markdown 渲染。
+- 图片自动处理。
+- 多语言支持。
 
 ## 🔧 环境变量说明
 
@@ -148,48 +147,48 @@ npm run deploy
 
 ### 构建失败
 
-1. 检查 GitHub Secrets 是否正确配置
-2. 确认 API Key 格式正确
-3. 查看 GitHub Actions 日志
+1. 检查 GitHub Secrets 是否正确配置。
+2. 确认 API Key 格式正确。
+3. 查看 GitHub Actions 日志。
 
 ### 本地开发问题
 
-1. 确认 `.env.local` 文件存在
-2. 验证 API Key 有效性
-3. 清除浏览器缓存
+1. 确认 `.env.local` 文件存在。
+2. 验证 API Key 有效性。
+3. 清除浏览器缓存。
 
 ### 部署问题
 
-1. 检查 GitHub Pages 设置
-2. 确认仓库 base 路径正确
-3. 验证工作流权限
+1. 检查 GitHub Pages 设置。
+2. 确认仓库 base 路径正确。
+3. 验证工作流权限。
 
 ## 🚀 性能优化
 
-- **代码分割**：按需加载组件
-- **图片优化**：自动压缩和懒加载
-- **缓存策略**：浏览器缓存和 CDN
-- **构建优化**：Tree shaking 和压缩
+- **代码分割**：按需加载组件。
+- **图片优化**：自动压缩和懒加载。
+- **缓存策略**：浏览器缓存和 CDN 。
+- **构建优化**： Tree shaking 和压缩。
 
 ## 📈 监控指标
 
-- **构建时间**：通常 < 2 分钟
-- **包大小**：主包 < 300KB
-- **加载性能**：首屏 < 3 秒
-- **API 响应**：< 2 秒
+- **构建时间**：通常 < 2 分钟。
+- **包大小**：主包 < 300KB 。
+- **加载性能**：首屏 < 3 秒。
+- **API 响应**：< 2 秒。
 
 ## 🤝 贡献指南
 
-1. Fork 项目
-2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
-3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
-4. 推送分支 (`git push origin feature/AmazingFeature`)
-5. 创建 Pull Request
+1. Fork 项目。
+2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)。
+3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)。
+4. 推送分支 (`git push origin feature/AmazingFeature`)。
+5. 创建 Pull Request 。
 
 ## 📄 许可证
 
-本项目采用开源许可证。详细信息请查看 [LICENSE](LICENSE) 文件。
+本项目采用开源许可证。详情请查看 [LICENSE](LICENSE) 文件。
 
 ---
 
-**🎯 目标**：打造最好的 Web3 学习平台，让每个人都能轻松入门区块链技术！
+**🎯 目标**：打造最好的 Web3 学习平台，让每个人都能轻松入门区块链技术！

DEPLOY_GUIDE.md

@@ -2,7 +2,7 @@
 
 ## 1. 目录与内容准备
 - 新建或修改章节时，务必在 `SUMMARY.md` 中添加对应的目录项，否则网页侧栏不会显示新章节。
-- 每个章节的内容建议放在对应的 `README.MD` 文件中，便于 GitBook/Honkit 自动识别。
+- 每个章节的内容建议放在对应的 `README.MD` 文件中，便于 GitBook / Honkit 自动识别。
 
 ## 2. 内容提交到主分支
 - 所有内容（如 `README.MD`、`SUMMARY.md` 等）修改后，**先用 git 提交并推送到 main 分支**：
@@ -25,30 +25,30 @@
   ```bash
   bash deploy.sh
   ```
-  > 注意：如果脚本提示有未提交的更改，需先提交（见第2步）。
+  > 注意：如果脚本提示有未提交的更改，需先提交（见第 2 步）。
 
 ## 5. 检查 GitHub Pages 设置
 - 在 GitHub 仓库的 `Settings > Pages`，确认：
   - 发布分支为 `gh-pages`
-  - 发布目录为 `/（root）`
+  - 发布目录为 `/ (root)`
 
 ## 6. 等待生效
 - 部署后，通常几分钟内网页会自动更新。访问地址一般为：
   ```
-  https://<你的GitHub用户名>.github.io/<仓库名>/
+  https://<你的 GitHub 用户名>.github.io/<仓库名>/
   ```
   如：`https://beihaili.github.io/Get-Started-with-Web3/`
 
 ## 7. 常见问题与排查
-- **新章节不显示**：多半是 `SUMMARY.md` 没加，或没重新 build/deploy。
-- **网页内容没变**：可能是没 push 到 main，或没重新 build/deploy，或浏览器缓存未刷新。
+- **新章节不显示**：多半是 `SUMMARY.md` 没加，或没重新 build / deploy 。
+- **网页内容没变**：可能是没 push 到 main，或没重新 build / deploy ，或浏览器缓存未刷新。
 - **脚本报错有未提交更改**：先 `git add . && git commit -m "xxx" && git push`。
 
 ---
 
-## 一键部署流程（推荐AI操作顺序）
-1. 检查/编辑 `SUMMARY.md`，确保目录完整。
-2. `git add . && git commit -m "更新SUMMARY和内容" && git push`
+## 一键部署流程（推荐 AI 操作顺序）
+1. 检查 / 编辑 `SUMMARY.md`，确保目录完整。
+2. `git add . && git commit -m "更新 SUMMARY 和内容" && git push`
 3. `honkit build`
 4. `bash deploy.sh`
 5. 等待几分钟，刷新网页查看效果。
@@ -81,8 +81,8 @@
    - 直接重置 `gh-pages` 分支内容，绕过 `gh-pages` CLI 对大提交或权限的限制。
 4. **验证上线**
    - 访问 `https://beihaili.github.io/Get-Started-with-Web3/`，或执行 `curl -I` 查看是否返回 `HTTP/2 200`。
-   - GitHub Pages 缓存通常 1~5 分钟，必要时强制刷新浏览器。
+   - GitHub Pages 缓存通常 1 - 5 分钟，必要时强制刷新浏览器。
 
 ---
 
-下次需要自动化部署，只需让AI严格按上述流程操作即可，遇到问题也可直接参考"常见问题与排查"部分。 
+下次需要自动化部署，只需让 AI 严格按上述流程操作即可，遇到问题也可直接参考「常见问题与排查」部分。

GITHUB_SECRETS_SETUP.md

@@ -1,30 +1,30 @@
 # 🔐 GitHub Secrets 配置指南
 
-为了安全地使用 Gemini AI 功能并启用自动部署，你需要在 GitHub 仓库中配置以下 Secrets。
+为了安全地使用 Gemini AI 功能并启用自动部署，你需要在 GitHub 仓库中配置以下 Secrets 。
 
 ## 🚀 快速设置步骤
 
 ### 1. 获取 Gemini API Key
 
-1. 访问 [Google AI Studio](https://aistudio.google.com/app/apikey)
-2. 登录你的 Google 账户
-3. 点击 "Create API Key" 创建新的 API 密钥
-4. 复制生成的 API Key（格式类似：`AIzaSyC...`）
+1. 访问 [Google AI Studio](https://aistudio.google.com/app/apikey)。
+2. 登录你的 Google 账户。
+3. 点击 「Create API Key」 创建新的 API 密钥。
+4. 复制生成的 API Key（格式类似： `AIzaSyC...` ）。
 
 ### 2. 配置 GitHub Secrets
 
-1. 访问你的 GitHub 仓库页面
-2. 点击 "Settings" 标签
-3. 在左侧菜单中选择 "Secrets and variables" → "Actions"
-4. 点击 "New repository secret" 添加以下密钥：
+1. 访问你的 GitHub 仓库页面。
+2. 点击 「Settings」 标签。
+3. 在左侧菜单中选择 「Secrets and variables」 → 「Actions」。
+4. 点击 「New repository secret」 添加以下密钥：
 
-#### 必需的 Secrets：
+#### 必需的 Secrets ：
 
 | Secret Name | 值 | 说明 |
 |-------------|-----|-----|
-| `GEMINI_API_KEY` | 你的 Gemini API Key | 用于 AI 功能，格式：AIzaSyC... |
+| `GEMINI_API_KEY` | 你的 Gemini API Key | 用于 AI 功能，格式： AIzaSyC... |
 
-#### 可选的 Secrets（有默认值）：
+#### 可选的 Secrets （有默认值）：
 
 | Secret Name | 默认值 | 说明 |
 |-------------|--------|-----|
@@ -41,32 +41,32 @@
    你的仓库 → Settings → Secrets and variables → Actions
    ```
 
-2. **点击 "New repository secret"**
+2. **点击 「New repository secret」**
 
 3. **添加 GEMINI_API_KEY**
    - Name: `GEMINI_API_KEY`
    - Secret: 粘贴你的 Gemini API Key
-   - 点击 "Add secret"
+   - 点击 「Add secret」
 
 ## 🔄 自动部署流程
 
-配置完成后，GitHub Actions 将会：
+配置完成后， GitHub Actions 将会：
 
-1. **自动触发**：每次推送到 `main` 分支时
-2. **安全构建**：使用配置的 Secrets 构建应用
-3. **自动部署**：将构建结果部署到 GitHub Pages
-4. **通知结果**：在 Actions 页面显示部署状态
+1. **自动触发**：每次推送到 `main` 分支时。
+2. **安全构建**：使用配置的 Secrets 构建应用。
+3. **自动部署**：将构建结果部署到 GitHub Pages 。
+4. **通知结果**：在 Actions 页面显示部署状态。
 
 ## 🏠 本地开发设置
 
 对于本地开发，你需要：
 
-1. 复制 `.env.example` 文件为 `.env.local`：
+1. 复制 `.env.example` 文件为 `.env.local` ：
    ```bash
    cp .env.example .env.local
    ```
 
-2. 在 `.env.local` 中填入你的 API Key：
+2. 在 `.env.local` 中填入你的 API Key ：
    ```bash
    VITE_GEMINI_API_KEY=你的_API_Key_在这里
    ```
@@ -78,19 +78,19 @@
 
 ## ⚠️ 安全注意事项
 
-- ✅ **DO**: 将 API Keys 添加到 GitHub Secrets
-- ✅ **DO**: 使用 `.env.local` 进行本地开发
-- ❌ **DON'T**: 将 API Keys 提交到代码仓库
-- ❌ **DON'T**: 在前端代码中硬编码敏感信息
-- ❌ **DON'T**: 分享或公开你的 API Keys
+- ✅ **DO**: 将 API Keys 添加到 GitHub Secrets 。
+- ✅ **DO**: 使用 `.env.local` 进行本地开发。
+- ❌ **DON'T**: 将 API Keys 提交到代码仓库。
+- ❌ **DON'T**: 在前端代码中硬编码敏感信息。
+- ❌ **DON'T**: 分享或公开你的 API Keys 。
 
 ## 🔍 验证配置
 
 配置完成后，你可以：
 
-1. **检查 Actions 状态**：访问仓库的 Actions 页面
-2. **查看部署日志**：点击任意 workflow 查看详细日志
-3. **测试网站功能**：访问部署的网站测试 AI 功能
+1. **检查 Actions 状态**：访问仓库的 Actions 页面。
+2. **查看部署日志**：点击任意 workflow 查看详细日志。
+3. **测试网站功能**：访问部署的网站测试 AI 功能。
 
 ## ❓ 常见问题
 
@@ -104,16 +104,16 @@ A: 检查 GitHub Actions 日志，通常是 Secrets 配置不正确。
 A: 确保 `.env.local` 文件存在并包含正确的 API Key。
 
 ### Q: 如何更新 API Key？
-A: 在 GitHub Secrets 页面找到对应的 Secret，点击编辑即可更新。
+A: 在 GitHub Secrets 页面找到对应的 Secret ，点击编辑即可更新。
 
 ## 🎯 下一步
 
 配置完成后，你就可以：
-- 🚀 推送代码自动部署
-- 🤖 使用 AI 助教功能  
-- 🧠 体验智能测验系统
-- 📊 查看学习进度统计
+- 🚀 推送代码自动部署。
+- 🤖 使用 AI 助教功能。  
+- 🧠 体验智能测验系统。
+- 📊 查看学习进度统计。
 
 ---
 
-**提示**：首次配置可能需要几分钟生效。如有问题，请检查 GitHub Actions 日志或提 Issue。
+**提示**：首次配置可能需要几分钟生效。如有问题，请检查 GitHub Actions 日志或提 Issue 。