Skip to content

Commit 38189eb

Browse files
committed
docs: 更新部署文档
1 parent 883b047 commit 38189eb

8 files changed

Lines changed: 21 additions & 40 deletions

File tree

.env.example

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,6 @@ CONTENT_DIR=./content
3030
# 解决: 配置自动触发机制,推荐使用 Repository Dispatch
3131
# 详见: docs/AUTO_BUILD_TRIGGER.md (5 步快速配置)
3232

33-
# ============================================
34-
# 统计与分析
35-
# ============================================
36-
37-
# Umami API 密钥,用于访问 Umami 统计数据
38-
# 如果在 config.ts 中启用了 Umami,建议在此配置 API 密钥
39-
UMAMI_API_KEY=your_umami_api_key_here
40-
4133
# ============================================
4234
# IndexNow SEO 配置
4335
# ============================================

.github/workflows/deploy.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,6 @@ jobs:
4343
# ENABLE_CONTENT_SYNC: true
4444
# CONTENT_REPO_URL: ${{ secrets.CONTENT_REPO_URL }}
4545
# USE_SUBMODULE: true
46-
47-
# 其他环境变量
48-
UMAMI_API_KEY: ${{ secrets.UMAMI_API_KEY }}
4946

5047
- name: Deploy to pages branch
5148
uses: JamesIves/github-pages-deploy-action@v4

README.ja.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,10 @@
148148
- **GitHub Pages:** 付属のGitHub Actionsワークフローを使用
149149
- **Cloudflare Pages:** リポジトリを接続
150150

151-
デプロイ前に、`astro.config.mjs``site` URLを更新してください。
151+
デプロイ前に、`src/config.ts``siteURL`を更新してください。
152+
153+
- **環境変数設定(オプション):** `.env.example`を参照して設定してください
154+
**推奨されません**`.env`ファイルをGitにコミットすること。`.env`はローカルデバッグまたはビルドのみで使用する必要があります。クラウドプラットフォームにデプロイする場合、プラットフォームの`環境変数`設定経由で設定することをお勧めします。
152155

153156
## 📝 投稿フロントマター形式
154157

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,15 @@ Get started quickly with our comprehensive documentation. Whether you're customi
3333
<tr>
3434
</table>
3535

36+
## 🚀 NEW: Automatic Resolution Adaptation
37+
38+
> **🎯 Automatic Resolution Algorithm** - Intelligently adapts content layout based on device screen resolution, providing the best viewing experience for all devices
39+
40+
🌏 README Language
41+
[**English**](./README.md) /
42+
[**中文**](./README.zh.md) /
43+
[**日本語**](./README.ja.md) /
44+
[**中文繁体**](./README.tw.md) /
3645

3746

3847
### 🔧 Component Configuration System Restructuring
@@ -140,15 +149,7 @@ Deploy your blog to any static hosting platform:
140149
- **GitHub Pages:** Use the included GitHub Actions workflow
141150
- **Cloudflare Pages:** Connect your repository
142151

143-
- **Environment Variable Configuration (Optional):** Configure in `.env` file or deployment platform
144-
145-
```bash
146-
# Umami API key for accessing Umami analytics data
147-
# If Umami is enabled in config.ts, it's recommended to configure the API key here
148-
UMAMI_API_KEY=your_umami_api_key_here
149-
# bcrypt salt rounds (10-14 recommended, default 12)
150-
BCRYPT_SALT_ROUNDS=12
151-
```
152+
- **Environment Variable Configuration (Optional):** Refer to `.env.example` for configuration
152153

153154
Before deployment, update the `siteURL` in `src/config.ts`.
154155
**Not recommended** to commit the `.env` file to Git. The `.env` file should only be used for local debugging or building. For cloud platform deployment, it's recommended to configure via the platform's `environment variables` settings.

README.tw.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,9 +151,10 @@
151151
- **GitHub Pages:** 使用包含的 GitHub Actions 工作流
152152
- **Cloudflare Pages:** 連接您的儲存庫
153153

154-
部署前,請在 `astro.config.mjs` 中更新 `site` URL
154+
部署前,請在 `src/config.ts` 中更新 `siteURL`
155155

156-
- **環境變數配置:** 如果你需要使用 Umami 統計,建議在部署平台設定環境變數 `UMAMI_API_KEY` 為你的 Umami API 金鑰,或直接在配置檔中修改。
156+
- **環境變數配置(可選):** 可參照 `.env.example` 來配置
157+
**不建議**`.env` 檔案提交到 Git,`.env` 應該僅在本地調試或構建使用。若要將項目在雲平台部署,建議通過平台上的 `環境變數` 配置傳入。
157158

158159
## 📝 文章前言格式
159160

README.zh.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -151,15 +151,7 @@
151151
- **GitHub Pages:** 使用包含的 GitHub Actions 工作流
152152
- **Cloudflare Pages:** 连接您的仓库
153153

154-
- **环境变量配置(可选):**`.env` 文件或部署平台配置
155-
156-
```bash
157-
# Umami API 密钥,用于访问 Umami 统计数据
158-
# 如果在 config.ts 中启用了 Umami,建议在此配置 API 密钥
159-
UMAMI_API_KEY=your_umami_api_key_here
160-
# bcrypt 盐值轮数(10-14 推荐,默认 12)
161-
BCRYPT_SALT_ROUNDS=12
162-
```
154+
- **环境变量配置(可选):** 可参照 `.env.example` 来配置
163155

164156
部署前,请在 `src/config.ts` 中更新 `siteURL`
165157
**不建议**`.env` 文件提交到 Git,`.env` 应该仅在本地调试或构建使用。若要将项目在云平台部署,建议通过平台上的 `环境变量` 配置传入。

docs/DEPLOYMENT.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,8 +406,9 @@ fatal: could not read Username for 'https://github.com'
406406
| `CONTENT_REPO_URL` | ⚠️ | - | 内容仓库地址 (启用内容分离时必需) |
407407
| `USE_SUBMODULE` || `false` | 是否使用 Git Submodule 模式 |
408408
| `CONTENT_DIR` || `./content` | 内容目录路径 |
409-
| `UMAMI_API_KEY` || - | Umami 统计 API 密钥 |
410-
| `BCRYPT_SALT_ROUNDS` || `12` | bcrypt 加密轮数 |
409+
| `INDEXNOW_KEY` || - | IndexNow API 密钥,用于向搜索引擎提交 URL 更新 |
410+
| `INDEXNOW_HOST` || - | 网站主机地址 |
411+
| `BILI_SESSDATA` || - | Bilibili SESSDATA,用于获取观看进度 |
411412

412413
⚠️ = 在特定模式下必需
413414

scripts/init-content-repo.js

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,6 @@ async function main() {
7373
7474
CONTENT_REPO_URL=${repoUrl.trim()}
7575
CONTENT_DIR=./content
76-
77-
# Umami configuration (optional)
78-
# UMAMI_API_KEY=your_api_key_here
79-
80-
# bcrypt configuration
81-
BCRYPT_SALT_ROUNDS=12
8276
`;
8377

8478
fs.writeFileSync(envPath, envContent);

0 commit comments

Comments
 (0)