Skip to content
界面图谱Interface Atlas
☰
中文
PagesPage / Documentation

Changelog

更新日志页

Aliases:更新日志更新日志页版本更新记录更新记录页发版说明版本历史页新版本改了啥更新公告页

What is it

A reverse-chronological record of every product change: each entry opens with a date and version, groups items into added, changed and fixed, and flags breaking changes with migration notes and links. It gives users and teams one shared source of truth for what an update changes for them.

Interactive playground

Try it. Make an informed choice.

Loading lab…

✓ When to use

  • The product ships many public versions over time
  • Users need to know what changed in their version
  • Behavior or API changes need migration notes

✕ When not to use

  • A single release, or the product is effectively frozen
  • Internal task streams — use the project tracker
  • A commit-by-commit developer view — use release pages

Variants

Timeline

时间线式

Vertical timeline anchored by date and version

Grouped

分组折叠

Collapsible per version, newest expanded by default

Feed

订阅流

Compact list with RSS or email subscribe

Page structure

  1. 01

    Header & subscribe

    States the release cadence and offers RSS or email subscribe.

  2. 02

    Latest release

    Pins the current version and highlights the most important change.

  3. 03

    Version entries

    One block per version, newest first, with anchor links.

  4. 04

    Change groups

    Added, changed and fixed kept separate, one line each.

  5. 05

    Migration note

    Breaking changes called out with the replacement path.

Implementation

gridflexcounter-reset: versionborder-left: 2px solid var(--color-line)position: sticky

Use an ordered list or article semantics; mark dates with time elements carrying datetime. Distinguish categories by label, not color alone. Draw the timeline with a left border and dot pseudo-elements; use native details or a controlled accordion. Keep subscribe visible but restrained; filtering is state-driven and preserves document order.

Related concepts

Timeline时间线

A display that orders events by time, using timestamps, markers and content to explain sequence. It works for activity logs, project journals or order history. Unlike a stepper, which emphasizes task stages to complete, a timeline tells an event story. Keep titles and times visible when details expand.

ComponentsContains
Accordion手风琴

A vertical list of collapsible sections: clicking a header expands its content and clicking again collapses it, either exclusively (one open at a time) or independently. Packs grouped content into limited space for on-demand expansion.

ComponentsContains
Badge徽标

A small status marker attached to an element's corner or inline: a dot, a count or a short label. It signals unread counts, status (new, deprecated) or category; non-interactive and visually subordinate to its host element.

ComponentsContains
Search Filtering搜索筛选

Narrows a large list to whatever matches the current input: every keystroke filters the list in place, with hit counts and an empty-state hint. Finding becomes pruning — no submit, no page jump, feedback stays right in front of the user.

PatternsUses pattern
Documentation Page文档页

A long-lived, reading-first content page: a collapsible docs tree on one side, the article column carrying heading hierarchy, paragraphs, code blocks and callouts, and on wide screens a page TOC marking the current position. Permanent links and prev/next links chain pages into a site; search is the primary entry; the structure is stable enough to memorize.

PagesSimilar

Sources

Markdown for agents · JSON