说明目录
Garden 使用说明组件参考garden timeline

组件参考 · timeline

按时间或阶段顺序排开版本演进、排查经过或关键节点。

← 组件参考 · 用法:时间线

1示例

代码

```garden timeline
title: 静态发布流水线执行步骤
items:
  - date: 步骤 1
    title: 同步内容与静态资源
    text: 校验文章信息、复制图片附件并生成搜索索引与 RSS。
  - date: 步骤 2
    title: 构建静态站点产物
    text: 把全部页面预渲染到静态目录。
  - date: 步骤 3
    title: 校验静态页面并部署
    text: 检查导出文件完整无误后发布到 GitHub Pages。
```

效果

静态发布流水线执行步骤

  1. 步骤 1

    同步内容与静态资源

    校验文章信息、复制图片附件并生成搜索索引与 RSS。

  2. 步骤 2

    构建静态站点产物

    把全部页面预渲染到静态目录。

  3. 步骤 3

    校验静态页面并部署

    检查导出文件完整无误后发布到 GitHub Pages。

2字段写法

```garden timeline
title:       # 可选,总标题
items:       # 必填,按时间先后
  - date:    # 可选,时间点
    title:   # 必填,节点标题
    text:    # 可选,说明
    source:  # 可选,来源网址
```

3字段

围栏写 ```garden timeline(编辑器代码片段触发词 ;gtimeline)。YAML 语法错误或顶层含未知键名时整块报 garden-yaml 错误。

字段是否必填默认值取值与限制说明
title可选无字符串时间线上方的总标题
items必填[]对象数组(建议至少 2 项,不做校验)按先后顺序排列的节点列表
items[].date可选无字符串节点上方的时间点、年份或阶段编号
items[].title必填""字符串节点标题
items[].text可选无字符串节点的具体说明
items[].source可选无网址、{ url, site?, icon? } 或数组跟在节点说明后的来源胶囊(未填 site 时默认取网址去掉 www. 后的域名)

4限制与报错

  • 除通用的 garden-yaml 外,本组件没有专属报错代码;表里写「不做校验」的建议值不会报错。
目录