Update
Easily manage and present change history.
The Update component helps you display release notes, version details, and changelogs in a standardized format.
Each Update label is added to the "On this page" sidebar and gets its own anchor, so you can link directly to a specific entry.
Example entry
You can include anything here - images, code snippets, or a bullet list of modifications.
Key additions
- Fully responsive layout
- Individual anchor for each update
- Automatic RSS feed entry generation
Update Usage
You can combine multiple Update components to build complete changelogs.
<Update label="v0.0.1" description="Example">
## Example entry
You can include anything here - images, code snippets, or a bullet list of modifications.
### Key additions
- Fully responsive layout
- Individual anchor for each update
- Automatic RSS feed entry generation
</Update>Subscribable changelogs
Every page that contains at least one Update component automatically publishes an RSS feed at its page URL with /rss.xml appended. For example, this page's feed lives at /update/rss.xml.
Each Update becomes a feed entry: the label is the entry title, and the entry link deep-links to the update's anchor on the page. New entries reach subscribers as soon as the site is rebuilt with new Update components.
Feed entries contain pure Markdown only. They exclude components, code, and HTML elements. Use the rss property to provide alternative text for feed readers when an update consists mostly of excluded content:
<Update label="v0.0.2" rss="Added dark mode and fixed sidebar links.">
<Frame></Frame>
</Update>The feed's channel title and description come from the page frontmatter, falling back to the site name and description from config.json. RSS feeds are only available on public documentation - password-protected sites do not expose them.
RSS feeds can integrate with Slack, email, or other subscription tools to notify readers of changes. Some options include:
RSS button
To make the feed discoverable, add rss: true to the page frontmatter. This displays an RSS button at the top of the page that links to the feed - this page shows one. The button only appears when the page actually contains Update components.
---
rss: true
---Properties
The label of the update. It also appears in the page's "On this page" navigation, acts as a deep-link anchor to this entry, and becomes the entry title in the page's RSS feed.
An optional description for the update. When omitted, no description is shown.
Alternative pure-Markdown text for this entry in the page's RSS feed. When omitted, the feed uses the entry content with components, code, and HTML removed. Never rendered on the page.
The content of the update.