Timeline

Vertical timeline for changelogs, version history, or sequential events. Each item shows a date, title, optional badge, and description. Badges like "new" and "breaking" have special styling.

API

Timeline

Prop	Type	Default	Description
`children`	`ReactNode`	—	One or more `<TimelineItem>` elements.

TimelineItem

Prop	Type	Default	Description
`date`	`string`	—	Date or version label.
`title`	`string`	—	Event or release title.
`badge`	`string`	—	Optional badge text. `"new"` and `"breaking"` have special styling; any other string displays as a neutral badge.
`children`	`ReactNode`	—	Description or details.

Example

PreviewCode

v2.0.0breaking

Major release

Dropped Python 3.8 support. Migrated to Pydantic v2. New plugin API.

v1.5.0new

Mermaid diagrams

Added support for Mermaid diagram rendering in documentation pages.

v1.4.2

Bug fixes

Fixed sidebar ordering issue with nested modules. Improved build performance.

v1.4.0new

Search customization

Added configurable search placeholder and the ability to disable search.


<Timeline>
  <TimelineItem date="v2.0.0" title="Major release" badge="breaking">
    Dropped Python 3.8 support. Migrated to Pydantic v2. New plugin API.
  </TimelineItem>
  <TimelineItem date="v1.5.0" title="Mermaid diagrams" badge="new">
    Added Mermaid diagram rendering support.
  </TimelineItem>
  <TimelineItem date="v1.4.2" title="Bug fixes">
    Fixed sidebar ordering and improved build performance.
  </TimelineItem>
</Timeline>