Aggiornamento

Il componente Update crea voci di changelog in stile timeline. Le voci compaiono nell'indice. Una voce può avere un'etichetta di data, una descrizione e tag di categoria. Usalo per pagine "Novità", changelog delle API e note di rilascio.

Usa Update quando:

• Documenti le release con numeri di versione o date
• Crei changelog che i lettori possono navigare tramite l'indice
• Annunci funzionalità con tag categorizzati (nuovo, correzione, modifica importante)

Utilizzo di base

<Update label="January 10, 2025">

Added support for dark mode across all themes.

</Update>

Con descrizione

Aggiungi contesto sotto la data:

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

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

</Update>

Con tag

Categorizza le voci con dei tag:

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

- Removed deprecated `legacyMode` option
- Updated authentication flow

</Update>

Più voci

Imposta più componenti Update in sequenza per un changelog completo:

Link di ancoraggio e sommario

Ogni Update genera un ID di ancora dalla sua etichetta (label="January 10, 2025" crea #january-10-2025). Le etichette compaiono anche nell'indice per una navigazione rapida.

Proprietà

Feed RSS

Aggiungi rss: true a qualsiasi pagina con componenti Update. Jamdesk genera un feed.xml durante le build. I lettori si iscrivono per ricevere gli aggiornamenti del changelog.

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

Quando è abilitato:

• Un'icona RSS compare accanto al titolo della pagina, con link al feed
• Un tag <link rel="alternate"> viene aggiunto all'<head> per il rilevamento automatico da parte di lettori RSS e browser
• Ogni <Update> diventa un elemento RSS con la sua etichetta come titolo e un link di ancoraggio alla voce

Impostazione delle date di pubblicazione

Usa la prop date per impostare il <pubDate> di ogni voce nel feed. Senza date, la voce compare nel feed ma senza timestamp.

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

Added dark mode support across all themes.

</Update>

Contenuto del feed

I feed RSS contengono solo testo semplice. La formattazione Markdown, i componenti MDX, i blocchi di codice e l'HTML vengono rimossi dalla descrizione del feed. Scrivi la prima frase come riepilogo leggibile anche senza formattazione.

URL del feed

Il feed è disponibile su /feed.xml (oppure /docs/feed.xml se il tuo sito usa hostAtDocs).

Il feed generato ha questo aspetto:

<?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>

Integrazione con altri strumenti

Aggiungi l'URL del feed a qualsiasi servizio compatibile con RSS:

• Slack: aggiungi l'app RSS con /feed a un canale.
• Discord: usa MonitoRSS o un bot simile per pubblicare automaticamente gli aggiornamenti.
• Email: collega il feed a Zapier o IFTTT per inviare email agli iscritti per ogni nuova voce.
• Browser: Safari, Vivaldi e Firefox (tramite estensioni) supportano RSS nativamente.

Best practice

Cosa fare dopo?