Appearance
项目文档与发布指南
这是一份给 AI 助手(opencode / Claude Code 等)读的说明。只有用户明确要求写项目文档或发布到博客时才执行。
一、触发条件
当用户说类似下面的话时才行动:
- 「写项目详解 / 项目说明 / 写文档 / 生成说明」
- 「发布 / 推送到博客 / 传到 GitHub / 写到博客里」
平时不要主动写这些文档,也不要主动推送。
二、写「项目详解」文档
- 位置:项目根目录
项目详解.md - 风格:保姆级、极详尽——包含背景、架构、目录结构、逐模块/逐段代码解释、数据流、扩展方法、踩坑与取舍
- 顶部 frontmatter(方便直接发到本站):
yaml
---
date: YYYY-MM-DD
category: projects
tags: [关键词1, 关键词2]
---- 可选:再写一份给 AI 速览用的
SKILL.md(frontmatter 含name和description),内容为:定位 / 技术栈 / 目录 / 常用命令 / 约定 / 坑 / 改动入口。
三、发布到本站
仓库:C:\Users\26817\Desktop\github\tech-blog分类:
| 分类 | 目录 |
|---|---|
| 项目 | docs/posts/projects/ |
| 实验 | docs/posts/experiments/ |
| AI 说明 | docs/posts/ai/ |
步骤:
- 把文章复制进对应分类目录,文件名用文章中文标题(如
我的世界AI伙伴夕瑟.md)。 - 在
.vitepress/config.mts的sidebar['/posts/']对应分组下加一行:{ text: '文章标题', link: '/posts/projects/文件名' } - 在
CHANGELOG.md末尾用当天日期追加一条记录。 - 构建验证:在博客目录运行
npm run build,确认无 dead link 报错。 - 推送:
powershell
cd "C:\Users\26817\Desktop\github\tech-blog"
git add .
git commit -m "本次改动说明"
git push推送后 Cloudflare Pages 会自动部署(约 1-2 分钟)。
四、硬性规则(来自仓库 CLAUDE.md)
- 永远不要删除已有文章,只能归档到
_archived/目录。 - 文章必须包含 frontmatter。
- 任何改动都必须追加
CHANGELOG.md。 - 仓库是私有的;只有 Cloudflare Pages 的网站是公开的。要让 AI 抓取,必须用网站域名,
raw.githubusercontent.com对私有仓库无效。