变更日志页面

通过编写用户可以按标签排序的变更日志条目来记录您的项目是如何变化的。变更日志会自动填充包含在 changelog 文件夹中的文件。

配置您的变更日志

在您的项目中添加一个 changelog 文件夹。此文件夹必须准确命名为 changelog — Fern 不会识别任何其他名称。

然后，在您的 docs.yml 中引用它。您可以将变更日志作为独立选项卡或作为导航中的一个部分。

1
tabs:
2
  guides:
3
    display-name: Guides
4
    icon: light book-open
5
  api:
6
    display-name: API Reference
7
    icon: light code
8
  changelog:
9
    display-name: Changelog
10
    icon: light clock
11
    changelog: ./changelog
12
13
navigation:
14
  - tab: guides
15
    layout:
16
      ...
17
  - tab: changelog

编写变更日志条目

通过编写 Markdown 文件创建新的变更日志条目。您可以使用 .md 或 .mdx 文件。使用 .mdx 的好处是您可以在条目中利用 Fern 内置的组件库。

1
---
2
tags: ["plants-api", "breaking-change", "inventory-management"]
3
---
4
5
## Summary
6
7
In the latest release, we've added endpoints to create a new Plant.
8
9
### What's new?
10
11
New endpoints:
12
13
- `POST /plant` add a new plant to inventory.
14
15
New object schemas:
16
17
- `CreatePlantRequest`
18
19
<Note> Have questions? Reach out to your local botanist. </Note>

条目日期

变更日志条目按文件名中指定的日期自动按时间顺序排序。使用以下格式之一指定条目的日期：

• MM-DD-YYYY（例如，10-06-2024）
• MM-DD-YY（例如，10-06-24）
• YYYY-MM-DD（例如，2024-04-21）

标签

为变更日志条目添加标签以帮助用户过滤和查找相关更新。标签在变更日志条目的前言中定义为字符串数组：

1
---
2
tags: ["plants-api", "breaking-change", "inventory-management"]
3
---

当您有多个变更日志条目时，用户可以通过选择特定标签来过滤变更日志页面。使用用户自然会搜索的具体、描述性标签。考虑按功能类型、产品区域、发布阶段、受影响平台或用户影响进行标记。

链接到条目

每个变更日志条目都有一个您可以引导用户访问的唯一 URL。例如，https://elevenlabs.io/docs/changelog/2025/3/31

概述页面

在您的 changelog 文件夹中添加一个 overview.mdx 文件，以在变更日志顶部包含高级概述。这对于总结主要主题、链接到外部发布说明或在深入了解具体条目之前为用户提供背景信息很有用。如果存在，它将自动出现在变更日志条目列表上方。

RSS 订阅源

变更日志自动配备 RSS 订阅源，以便用户可以订阅更新。通过在变更日志路径后添加 .rss 来导航到 RSS 订阅源。例如，https://elevenlabs.io/docs/changelog.rss