Skip to content

Frontmatter 规范(v1.5)

本项目默认使用 Markdown + frontmatter 作为索引事实源。
执行 npm run content:build 时,会自动扫描文档并生成统一索引数据。

通用字段

字段类型说明示例
titlestring标题title: 交付阅读台正式版交付
dateYYYY-MM-DD事件日期(更新流常用)date: 2026-03-30
updatedYYYY-MM-DD最近更新时间(项目/交付常用)updated: 2026-03-30
statusstringdoing/done/blocked/plannedstatus: doing
summarystring列表摘要summary: 完成 v1.1 架构升级
projectstring所属项目project: Delivery Reading Desk
tagsarray 或逗号分隔标签tags: [vitepress, delivery]
attachmentsarray 或逗号分隔附件站内路径attachments: [/attachments/delivery-reading-desk/a.pdf]

项目业务字段(v1.5 新增)

以下字段主要用于 projects/*.md,会进入首页多项目总览与业务状态面板:

字段类型说明
prioritynumber项目排序优先级,越小越靠前
phasestring当前阶段
nextActionstring下一步动作
ownerActionNeededyes/no是否需要老板动作
ownerActionTextstring老板动作说明
risklow/medium/high 或字符串当前风险
notifyStatusstring最近通知状态
lastNotifyYYYY-MM-DD最近通知时间
statusNotestring补充状态说明

各目录最小建议

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
---