Component reference · timeline
Order release milestones, incident steps, or build stages along a vertical sequence.
← Component reference · Usage: timeline
1Examples
Code
```garden timeline
title: Static Publishing Pipeline Stages
items:
- date: Step 1
title: Sync Content and Assets
text: Run `npx garden sync` to validate Front Matter, copy image attachments, and generate the search index and RSS feed.
- date: Step 2
title: Build Static Site Output
text: Run `STATIC_EXPORT=1 npx garden build` to prerender every route into `dist/client/`.
- date: Step 3
title: Validate Output and Deploy
text: Run `npm run pages:validate` to confirm `index.html` exists and no `.env`, source directories, `.map` or `.md` files, or symlinks were included, then publish to GitHub Pages.
```
Preview
Static Publishing Pipeline Stages
Step 1
Sync Content and Assets
Run
npx garden syncto validate Front Matter, copy image attachments, and generate the search index and RSS feed.Step 2
Build Static Site Output
Run
STATIC_EXPORT=1 npx garden buildto prerender every route intodist/client/.Step 3
Validate Output and Deploy
Run
npm run pages:validateto confirmindex.htmlexists and no.env, source directories,.mapor.mdfiles, or symlinks were included, then publish to GitHub Pages.
2Syntax
```garden timeline
title: # optional, heading
items: # required, in order
- date: # optional, date
title: # required, heading
text: # optional, description
source: # optional, source URL
```
3Fields
Fence header: ```garden timeline (snippet trigger ;gtimeline). Invalid YAML or unknown top-level keys report garden-yaml on the block.
| Field | Required | Default | Allowed Values & Limits | Description |
|---|---|---|---|---|
title | Optional | none | string | Heading above the timeline |
items | Required | [] | object[] (at least 2 items recommended, not checked) | Ordered list of steps or milestones |
items[].date | Optional | none | string | Timestamp, year, or stage label above the item title |
items[].title | Required | "" | string | Step heading |
items[].text | Optional | none | string | Detailed explanation for the step |
items[].source | Optional | none | URL, { url, site?, icon? }, or array | Source attribution chip appended to the step text (site defaults to the URL hostname without www.) |
4Limits & errors
- Apart from the shared
garden-yaml, this component has no error codes of its own; values marked "not checked" in the table never report an error.