diff --git a/README.md b/README.md index 78d0221..19edce0 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,36 @@
点击查看/隐藏更新日志 +### 2025/12/27 + +细节见:[`config/update-instructions-20251227.md`](config/update-instructions-20251227.md) + +**1. 页面模板差异化改进(Phase 1/Phase 2)** +- 首页判定规则调整:`site.yml -> navigation` 第一项即首页(不再依赖 `home` 页面/ID) +- 模板体系整理:通用 `page` + 特殊页 `projects/articles/bookmarks` + 内置 `search-results` +- `bookmarks` 标题后追加只读更新时间:`update: YYYY-MM-DD | from: git|mtime` +- `articles` Phase 2:RSS 聚合文章条目(只读 `data-type="article"`),按 `articles.yml` 分类聚合展示;保留隐藏写回结构避免干扰扩展 +- `projects`:repo 风格卡片(language/stars/forks 自动抓取)+ 可选 GitHub 贡献热力图 + +**2. 工作流与时效性数据刷新** +- GitHub Actions 构建前自动执行 `sync-projects` / `sync-articles` +- 新增 `schedule` 定时触发刷新(cron 使用 UTC,可在 workflow 中调整) + +**3. 配置与兼容清理(Breaking)** +- 移除旧版单文件配置 `config.yml/config.yaml` 回退 +- 移除独立 `navigation.yml` 回退 +- 移除 `pages/home.yml -> 顶层 categories` 与 `home` 子菜单特例 +- `navigation[].active` 不再生效(首页/默认打开页始终由 `navigation` 第一项决定) + +**4. 配置变更(字段新增/减少)** +- 新增: + - `site.rss.*`:articles RSS 抓取与缓存配置(用于 `npm run sync-articles`) + - `site.github.*`:projects 热力图与仓库元信息抓取缓存配置(用于 `npm run sync-projects`) + - `pages/.yml -> template`:页面模板选择(缺省时按回退规则使用 `page`) +- 说明: + - “首页”始终由 `site.yml -> navigation` 第一项决定,不要求页面 id 为 `home` + + ### 2025/12/23 **1. 侧边栏与导航交互优化** @@ -209,6 +239,7 @@ menav/ ## 文档导航 +- 更新说明2025/12/27(兼容性移除 / 迁移指南):[`config/update-instructions-20251227.md`](config/update-instructions-20251227.md) - 配置系统(完全替换策略、目录结构、示例):[`config/README.md`](config/README.md) - 书签导入(格式要求、流程、常见问题):[`bookmarks/README.md`](bookmarks/README.md) - 模板系统(组件、回退、数据流):[`templates/README.md`](templates/README.md) diff --git a/config/update-instructions-20251227.md b/config/update-instructions-20251227.md new file mode 100644 index 0000000..6f9bc84 --- /dev/null +++ b/config/update-instructions-20251227.md @@ -0,0 +1,103 @@ +# 更新说明(2025-12-27) + +本文档用于说明“页面模板差异化改进”相关改动中,**配置层面的新增字段、减少字段与迁移要点**。内容与 [`README.md`](../README.md) 的“2025/12/27 更新记录”保持一致。 + +最后更新:2025-12-27 + +--- + +## 1. 新增/扩展的配置字段 + +### 1.1 `site.rss.*`(articles RSS 聚合 / 缓存) + +用途:为 `articles` 页面提供 RSS/Atom 文章聚合数据,供 `npm run sync-articles` 联网抓取并写入缓存;`npm run build` 默认不联网,只读取缓存渲染。 + +关键字段(默认示例见 `config/_default/site.yml`): +- `site.rss.enabled`:是否启用 RSS 抓取能力 +- `site.rss.cacheDir`:缓存目录(建议 `dev/`,仓库默认 gitignore) +- `site.rss.fetch.*`:抓取参数(超时、并发、重试、重定向等) +- `site.rss.articles.*`:抓取条数与摘要长度(例如每站点最多 8 篇) + +说明: +- RSS 抓取只影响 `articles` Phase 2(文章条目只读展示),不会影响扩展对“来源站点(sites)”的写回能力(构建会保留影子写回结构)。 + +--- + +### 1.2 `site.github.*`(projects 仓库元信息 + 热力图) + +用途: +- projects 卡片可展示仓库元信息(language/stars/forks 等,只读),由 `npm run sync-projects` 联网抓取并写入缓存。 +- projects 标题区右侧可选展示 GitHub 贡献热力图。 + +关键字段(默认示例见 `config/_default/site.yml`): +- `site.github.username`:GitHub 用户名;为空则不展示热力图 +- `site.github.heatmapColor`:热力图主题色(不带 `#`,如 `339af0`) +- `site.github.cacheDir`:仓库元信息缓存目录(建议 `dev/`) + +说明: +- 仓库元信息来自 GitHub API,属于“时效性数据”,不会写回到 `pages/projects.yml`。 + +--- + +### 1.3 `pages/.yml -> template`(页面模板选择) + +用途:指定页面使用的模板(对应 `templates/pages/