README.md

Mizuki 文档索引

欢迎查阅 Mizuki 的详细文档！

📚 文档列表

核心文档

• ../README.zh.md - 项目主文档 (简体中文)
  • 快速开始
  • 功能特性
  • 基础配置
  • 常见问题

多语言文档

• ../README.md - English
• ../README.ja.md - 日本語
• ../README.tw.md - 繁體中文

内容分离相关

• CONTENT_SEPARATION.md - 内容分离完整指南 ⭐

  • ENABLE_CONTENT_SYNC 控制开关
  • 环境变量配置详解
  • 私有仓库配置方法
  • 模式切换指南
  • 故障排查

• CONTENT_REPOSITORY.md - 内容仓库结构指南

  • 推荐的目录结构
  • 文件组织方式
  • 内容编写规范
  • 图片管理建议

• MIGRATION_GUIDE.md - 内容迁移指南

  • 从单仓库迁移到分离模式
  • 详细迁移步骤
  • 测试验证方法

部署相关

• DEPLOYMENT.md - 部署完整指南 ⭐

  • 各平台部署配置 (GitHub Pages / Vercel / Netlify / Cloudflare Pages)
  • 内容仓库更新自动触发构建
  • 私有仓库认证
  • 故障排查

• AUTO_BUILD_TRIGGER.md - 自动构建触发快速参考 🆕

  • 5 步快速配置，解决内容更新不触发部署的问题

🚀 快速查找

我是新手，想快速开始

→ 阅读 主 README

我想部署博客

→ 阅读 部署指南

我想使用内容分离功能

→ 阅读 内容分离完整指南

我想从单仓库迁移到分离模式

→ 阅读 内容迁移指南

我想配置私有内容仓库

→ 阅读 内容分离指南 - 私有仓库配置

我的部署遇到问题

→ 阅读 部署指南 - 故障排查

我遇到了内容同步错误

→ 阅读 内容分离指南 - 故障排查

内容仓库更新后站点没有自动重新部署 🆕

→ 阅读 自动构建触发快速参考

📖 文档架构

docs/
├── README.md                    # 本文档 - 索引导航
├── CONTENT_SEPARATION.md        # 内容分离核心指南
├── CONTENT_REPOSITORY.md        # 内容仓库结构
├── MIGRATION_GUIDE.md           # 迁移指南
├── DEPLOYMENT.md                # 部署完整指南
├── AUTO_BUILD_TRIGGER.md        # 自动构建触发快速参考
└── image/                       # 文档图片资源

🎯 文档使用建议

新用户推荐阅读顺序

1. 主 README - 了解项目基本情况
2. 部署指南 - 选择平台并部署
3. (可选) 内容分离指南 - 高级功能

高级用户推荐

• 直接查阅具体主题的文档
• 使用快速查找定位问题解决方案

🤝 需要帮助？

• 查看 GitHub Issues
• 阅读相关文档的故障排查章节
• 运行 pnpm run check-env 检查配置

祝你使用愉快！🎉