Appearance
Frontmatter 规范(v1.5)
本项目默认使用 Markdown + frontmatter 作为索引事实源。
执行 npm run content:build 时,会自动扫描文档并生成统一索引数据。
通用字段
| 字段 | 类型 | 说明 | 示例 |
|---|---|---|---|
title | string | 标题 | title: 交付阅读台正式版交付 |
date | YYYY-MM-DD | 事件日期(更新流常用) | date: 2026-03-30 |
updated | YYYY-MM-DD | 最近更新时间(项目/交付常用) | updated: 2026-03-30 |
status | string | doing/done/blocked/planned | status: doing |
summary | string | 列表摘要 | summary: 完成 v1.1 架构升级 |
project | string | 所属项目 | project: Delivery Reading Desk |
tags | array 或逗号分隔 | 标签 | tags: [vitepress, delivery] |
attachments | array 或逗号分隔 | 附件站内路径 | attachments: [/attachments/delivery-reading-desk/a.pdf] |
项目业务字段(v1.5 新增)
以下字段主要用于 projects/*.md,会进入首页多项目总览与业务状态面板:
| 字段 | 类型 | 说明 |
|---|---|---|
priority | number | 项目排序优先级,越小越靠前 |
phase | string | 当前阶段 |
nextAction | string | 下一步动作 |
ownerActionNeeded | yes/no | 是否需要老板动作 |
ownerActionText | string | 老板动作说明 |
risk | low/medium/high 或字符串 | 当前风险 |
notifyStatus | string | 最近通知状态 |
lastNotify | YYYY-MM-DD | 最近通知时间 |
statusNote | string | 补充状态说明 |
各目录最小建议
updates/*.md
- 建议至少:
title,date,status,summary,project
projects/*.md
- 建议至少:
title,status,summary,tags - 若要进入业务面板,建议再补:
priority,phase,nextAction,ownerActionNeeded,risk
deliveries/*.md
- 建议至少:
title,project,status,updated,summary
示例:更新文档
yaml
---
title: 交付阅读台 v1.1 完成
date: 2026-03-30
status: done
project: Delivery Reading Desk
summary: 完成自动索引、组件化首页、部署与通知骨架
tags: [release, v1.1]
---示例:项目文档(含业务字段)
yaml
---
title: Release Ops Pipeline
status: doing
updated: 2026-03-30
summary: 管理构建、Cloudflare 发布、Telegram 通知与回传闭环的发布运维子项目
project: Release Ops Pipeline
priority: 2
phase: v1 发布闭环已打通
nextAction: 把更多发布状态与通知结果转成 frontmatter 驱动,并准备接 CI
ownerActionNeeded: no
ownerActionText: 当前不需要;若要上自动化发布,再拍板 CI 路线即可
risk: medium
notifyStatus: sent
lastNotify: 2026-03-30
statusNote: 当前本地一条命令发布可用,CI 尚未接入
---示例:交付文档
yaml
---
title: 交付阅读台正式版交付
project: Delivery Reading Desk
status: done
updated: 2026-03-30
summary: 站点骨架与交付阅读链路上线
attachments:
- /attachments/delivery-reading-desk/README.txt
---