Hexo-theme-redefine 项目部署时 CNAME 文件丢失问题分析与解决方案

问题背景

在使用 Hexo-theme-redefine 主题搭建个人博客并部署到 GitHub Pages 时，许多用户遇到了一个常见问题：每次部署后，仓库中的 CNAME 文件都会被自动删除。CNAME 文件是 GitHub Pages 用于自定义域名的重要配置文件，它的丢失会导致自定义域名无法正常访问，出现 404 错误。

问题原因分析

经过技术分析，这个问题主要源于 Hexo 的部署机制和 GitHub Pages 的工作方式：

1. Hexo 部署机制：Hexo 的 hexo deploy 命令会完全重建部署目录（通常是 .deploy_git），然后推送到远程仓库。在这个过程中，所有非生成的文件（包括 CNAME）都会被清除。

2. GitHub Pages 要求：GitHub Pages 要求 CNAME 文件必须位于仓库根目录才能生效。当这个文件被删除后，GitHub 就无法识别自定义域名配置。

3. 主题配置误解：虽然用户在 _config.redefine.yml 和 config.yml 中正确设置了 URL，但这些配置仅影响生成的链接，不会自动创建或保留 CNAME 文件。

解决方案

方法一：手动创建 CNAME 文件（推荐）

1. 在博客项目的 source 目录下创建一个名为 CNAME 的文件
2. 文件中只需写入你的域名（如 blog.example.com），不需要 http:// 或 https:// 前缀
3. 这个文件会被 Hexo 直接复制到最终生成的静态文件中，不会被删除

方法二：使用自定义部署脚本

对于需要更精细控制部署过程的用户，可以创建一个自定义部署脚本：

#!/bin/bash
# 删除旧的 gh-pages 分支
git branch -D gh-pages

# 清理并生成静态文件
hexo clean
hexo generate

# 清空部署目录并复制新文件
rm -rf .deploy_git/*
cp -r public/* .deploy_git/

# 创建 CNAME 文件
echo "YOUR_DOMAIN.com" > .deploy_git/CNAME

# 提交并推送更改
cd .deploy_git || exit
git init
git add .
git commit -m "更新站点 $(date +"%Y-%m-%d %T")"
git remote add origin YOUR_REPOSITORY_URL
git checkout -b gh-pages
git push -u origin gh-pages --force

这个脚本的优势在于：

• 完全控制部署过程
• 确保 CNAME 文件被正确创建
• 可以添加更多自定义部署逻辑

最佳实践建议

1. 版本控制：将 CNAME 文件纳入版本控制，这样即使重新部署也不会丢失。

2. 自动化部署：可以将上述脚本集成到 CI/CD 流程中，实现自动化部署。

3. 域名验证：在 GitHub Pages 设置中添加自定义域名后，GitHub 会自动验证并在仓库中创建 CNAME 文件，此时应保留这个文件。

4. DNS 配置：确保 DNS 设置正确，通常需要添加 CNAME 记录指向 username.github.io。

总结

Hexo-theme-redefine 主题部署时 CNAME 文件丢失的问题，本质上是静态站点生成器工作流程与 GitHub Pages 要求之间的不匹配。通过理解 Hexo 的部署机制和 GitHub Pages 的工作原理，我们可以采用多种方法确保 CNAME 文件被正确保留。无论是简单的文件创建方法，还是更复杂的自定义部署脚本，都能有效解决这个问题，让你的自定义域名稳定可用。