Skip to content

chore(docs): 忽略搜索索引产物并在 dev 启动时生成#131

Merged
cc-hearts merged 1 commit into
mainfrom
chore/docs-ignore-search-index
Jul 10, 2026
Merged

chore(docs): 忽略搜索索引产物并在 dev 启动时生成#131
cc-hearts merged 1 commit into
mainfrom
chore/docs-ignore-search-index

Conversation

@cc-hearts

Copy link
Copy Markdown
Member

🤔 本次变更属于 ...

  • 📦 包体积优化
  • ❓ 其他(生成产物管理)

🔗 相关 Issue

无。延续 #129 引入的站点全文搜索功能做收尾清理。

💡 背景与方案

packages/docs/public/search.cn.json(1.3M)与 search.en.json(3.6M)是由 scripts/gen-search.mjssrc/pages/**/*.md 自动生成的索引产物,并非手写内容。它们此前被纳入 git 追踪,带来两个问题:

  1. 仓库膨胀:合计约 5MB 的派生数据长期入库;
  2. diff 噪音:产物内含 meta.generatedAt 时间戳,每次 build 都会产生无意义变更,污染提交历史。

与已忽略的同类生成产物(llms.txt / llms-full.txt / llms-full-cn.txt / public/**/*.md)保持一致处理方式。

方案:

  • 将两个索引文件加入 .gitignore
  • git rm --cached 从索引移除(磁盘文件保留,dev/build 时重新生成);
  • 关键配套dev 脚本原本不调用 gen-search.mjs,若直接忽略会导致 clone 后首次 vp dev 搜索框 fetch /search.cn.json 404。因此在 dev 脚本中补充 node ./scripts/gen-search.mjs,与 build 行为对齐。

无 UI / 交互变化。

📝 变更日志

语言 变更日志
🇺🇸 英文 Stop tracking auto-generated search index files; generate them in dev script to avoid 404.
🇨🇳 中文 不再追踪自动生成的搜索索引文件,并在 dev 脚本中生成以避免 404。

- 将自动生成的 search.cn.json / search.en.json 加入 .gitignore,
  与 llms.txt 等生成产物保持一致,避免 ~5MB 仓库膨胀及
  generatedAt 时间戳造成的无意义 diff
- git rm --cached 移除已追踪的两个索引文件(磁盘文件保留)
- dev 脚本补充 node ./scripts/gen-search.mjs,确保 clone 后
  直接 vp dev 搜索功能不会 404,与 build 行为对齐
@cc-hearts cc-hearts merged commit d337a51 into main Jul 10, 2026
1 check passed
@cc-hearts cc-hearts deleted the chore/docs-ignore-search-index branch July 10, 2026 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant