更新日志 (Changelogs)
changelog 容器为记录项目演进提供专用布局。它将版本或日期标题解析为垂直时间线条目,确保发布说明清晰且易于快速浏览。
容器语法 (Container Syntax)
::: changelog # 外层版本历史容器开启
::: log [title:"v1.0.0 (YYYY-MM-DD)"] # 单个版本条目开启
发布细节(Markdown 标题、项目符号、提示框)...
::: /log # 显式日志条目闭合
::: log [title:"v0.9.0 (YYYY-MM-DD)"] # 第二个版本条目开启
发布说明...
::: /log
::: /changelog # 显式更新日志闭合
功能特性与支持属性 (Features & Attributes)
| 参数 / 元素 | 类型 | 描述 |
|---|---|---|
| 版本标签 | "String" | title:"..." |
渲染在左侧边距作为时间线徽章的版本号或日期。 |
| 子容器包装 | ::: log … ::: /log |
显式版本条目子容器。传统 == 版本 标记亦获完全支持。 |
| 闭合标签 | ::: /changelog, ::: /log, ::: |
支持显式命名闭合标签或通用 ::: 闭合标记。 |
v0.9.1+ 容器语法标准化
自 v0.9.1 起,docmd 引入了显式的容器开启与闭合标签(例如 ::: card … ::: /card、::: tab … ::: /tab)、显式的键值对属性(title:"..."、url:"...")以及末尾的 # 注释。推荐在编写新文档时采用此现代语法。同时,对传统子块标记(== tab、1.)和位置参数退避逻辑的向下兼容将被严格保留。
使用示例
::: changelog # 生产发布历史
::: log "v2.0.0 (2026-03-15)" # 大版本发布
### 核心系统重构
核心引擎已重构支持同构执行。
::: /log
::: log "v1.5.1 (2025-12-10)" # 补丁更新
### 安全补丁
* 修复内部解析器安全漏洞。
::: /log
::: /changelog
首次公开发布。
传统 == 条目标记语法
现有使用 == 条目标记的文档仍可平滑解析:
::: changelog
== v1.0.0 (2024-05-01)
首次公开发布。
::: /changelog
面向 AI 智能体的历史上下文
更新日志容器为 AI 智能体提供了时间维度的演进路线图。::: changelog 结构使 LLM 能够解析在 llms.txt 上下文流中何时引入了特定 API 或安全修复。