🚀 发布操作指南
本工具是一个自动化发布脚本,用于快速将项目部署到 GitHub Pages。
功能特性
- ✅ 自动构建静态资源
- ✅ 一键推送到 GitHub Pages
- ✅ 支持自定义部署分支
- ✅ 自动更新 sitemap
- ✅ 自动更新文章索引
- ✅ 自动生成主页最新文章
快速开始
1. 安装依赖
bash
pnpm install2. 配置仓库
确保你的项目已经初始化 git 仓库,并且远程仓库已配置:
bash
git remote -v如果没有配置,添加远程仓库:
bash
git remote add origin https://github.com/your-username/your-repo.git3. 执行发布
bash
pnpm run deploy脚本会自动完成以下步骤:
- 执行
pnpm run build构建项目 - 进入
dist目录 - 初始化 git 并提交所有文件
- 强制推送到
gh-pages分支
高级用法
自定义部署分支
bash
# 部署到 main 分支
pnpm run deploy:main
# 部署到自定义分支
DEPLOY_BRANCH=custom-branch pnpm run deploy仅构建不推送
bash
pnpm run build构建产物会输出到 dist 目录。
自动更新文章索引
新建文章后,运行以下命令可自动将文章链接添加到对应分类的 intro.md 中:
bash
pnpm update:intro脚本会:
- 扫描各分类目录下的
.md文件 - 从 frontmatter 或文件名获取文章标题
- 更新对应
intro.md的文章列表
示例:
bash
# 新建文章后
echo "# 我的文章" > web/tech/新文章.md
# 自动更新索引
pnpm update:intro自动生成主页最新文章
主页会自动显示各分类的最新文章(每个分类最多 3 篇)。构建时自动生成数据,无需手动操作。
手动更新(开发模式):
bash
pnpm generate:posts自动更新(构建模式):
bash
pnpm web:build
# buildEnd 钩子会自动运行 generate:posts效果:
- 主页 features 下方会显示 "📰 最近更新" 区域
- 按分类展示最新文章标题
- 点击文章标题可直接跳转阅读
- 点击分类名称可进入分类首页
常见问题
Q: 推送失败怎么办?
检查以下几点:
- 是否有仓库的写入权限
- 是否配置了正确的 SSH 或 Token
- 网络连接是否正常
Q: 如何取消部署?
在 GitHub 仓库设置中删除 gh-pages 分支即可。
Q: 自定义域名如何配置?
在 dist 目录下创建 CNAME 文件,内容为你的域名:
your-domain.com相关资源
如有问题,欢迎提 Issue 讨论 💬