Update

Die Komponente Update erstellt Changelog-Einträge im Zeitleisten-Stil. Die Einträge erscheinen im Inhaltsverzeichnis. Ein Eintrag kann ein Datumslabel, eine Beschreibung und Kategorie-Tags enthalten. Verwenden Sie sie für Seiten mit „Neuigkeiten“, API-Changelogs und Release-Notes.

Verwenden Sie Update, wenn Sie:

• Releases dokumentieren mit Versionsnummern oder Datumsangaben
• Changelogs aufbauen, durch die Leser über das ToC navigieren können
• Funktionen ankündigen mit kategorisierten Tags (new, fix, breaking)

Grundlegende Verwendung

<Update label="January 10, 2025">

Added support for dark mode across all themes.

</Update>

Mit Beschreibung

Fügen Sie Kontext unterhalb des Datums hinzu:

<Update label="January 5, 2025" description="Breaking change">

The `getData()` function now requires an options object.

</Update>

Mit Tags

Kategorisieren Sie Einträge mit Tags:

<Update label="December 20, 2024" tags={["breaking", "api"]}>

- Removed deprecated `legacyMode` option
- Updated authentication flow

</Update>

Mehrere Einträge

Stapeln Sie Update-Komponenten für ein vollständiges Changelog:

Ankerlinks und Inhaltsverzeichnis

Jedes Update erzeugt aus seinem Label eine Anker-ID (label="January 10, 2025" erzeugt #january-10-2025). Labels erscheinen außerdem im Inhaltsverzeichnis für die schnelle Navigation.

Props

RSS-Feed

Fügen Sie rss: true zu jeder Seite mit Update-Komponenten hinzu. Jamdesk erzeugt bei Builds einen feed.xml. Leser abonnieren ihn für Changelog-Updates.

---
title: Changelog
rss: true
---

Wenn aktiviert:

• Erscheint ein RSS-Symbol neben dem Seitentitel, das auf den Feed verlinkt
• Wird ein <link rel="alternate">-Tag im <head> für die automatische Erkennung durch RSS-Reader und Browser hinzugefügt
• Wird jedes <Update> zu einem RSS-Item mit seinem Label als Titel und einem Anker-Link zurück zum Eintrag

Veröffentlichungsdaten festlegen

Verwenden Sie das Prop date, um das <pubDate> für jeden Eintrag im Feed festzulegen. Ohne date erscheint der Eintrag im Feed, aber ohne Zeitstempel.

<Update label="March 2025" date="2025-03-15" tags={["feature"]}>

Added dark mode support across all themes.

</Update>

Feed-Inhalt

RSS-Feeds enthalten nur Klartext. Markdown-Formatierung, MDX-Komponenten, Code-Blöcke und HTML werden aus der Feed-Beschreibung entfernt. Schreiben Sie den ersten Satz als Zusammenfassung, die auch ohne Formatierung gut lesbar ist.

Feed-URL

Der Feed ist unter /feed.xml verfügbar (bzw. /docs/feed.xml, falls Ihre Site hostAtDocs verwendet).

Der erzeugte Feed sieht so aus:

<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>Acme Docs Changelog</title>
    <link>https://docs.acme.com</link>
    <description>Updates and changelog for Acme Docs</description>
    <item>
      <title>March 2025 — New dashboard</title>
      <link>https://docs.acme.com/changelog#march-2025</link>
      <pubDate>Sat, 15 Mar 2025 00:00:00 GMT</pubDate>
      <description>Added dark mode support across all themes.</description>
    </item>
  </channel>
</rss>

Integration mit anderen Tools

Fügen Sie die Feed-URL zu jedem RSS-kompatiblen Dienst hinzu:

• Slack: Fügen Sie die RSS-App mit /feed zu einem Kanal hinzu.
• Discord: Verwenden Sie MonitoRSS oder einen ähnlichen Bot, um Updates automatisch zu posten.
• E-Mail: Verbinden Sie den Feed mit Zapier oder IFTTT, um Abonnenten bei neuen Einträgen per E-Mail zu informieren.
• Browser: Safari, Vivaldi und Firefox (über Erweiterungen) unterstützen RSS nativ.

Bewährte Vorgehensweisen

Wie geht es weiter?