Update
Entradas de changelog estilo línea de tiempo con fechas, descripciones y etiquetas de categoría. Se integra con tu Tabla de contenidos para la navegación.
El componente Update crea entradas de changelog estilo línea de tiempo que se integran automáticamente con tu Tabla de contenidos. Cada entrada puede tener una etiqueta de fecha, descripción y etiquetas de categoría, lo que lo hace ideal para páginas de "Novedades", changelogs de API y notas de versión.
Usa Update cuando:
- Documentes versiones con números de versión o fechas
- Construyas changelogs que los lectores puedan navegar mediante la TdC
- Anuncies funcionalidades con etiquetas categorizadas (new, fix, breaking)
Uso básico
Added support for dark mode across all themes.
<Update label="January 10, 2025">
Added support for dark mode across all themes.
</Update>Con descripción
Agrega contexto debajo de la fecha:
Breaking change
The getData() function now requires an options object.
<Update label="January 5, 2025" description="Breaking change">
The `getData()` function now requires an options object.
</Update>Con etiquetas
Categoriza las entradas con etiquetas:
- Removed deprecated
legacyModeoption - Updated authentication flow
<Update label="December 20, 2024" tags={["breaking", "api"]}>
- Removed deprecated `legacyMode` option
- Updated authentication flow
</Update>Múltiples entradas
Apila componentes Update para un changelog completo:
New export functionality for PDF and CSV formats.
Fixed timezone handling in scheduled posts.
The v1 API endpoints are now deprecated. Migrate to v2 by March 2025.
Enlaces de anclaje y TdC
Cada Update genera un ID de anclaje a partir de su etiqueta (label="January 10, 2025" crea #january-10-2025). Las etiquetas también aparecen en la Tabla de contenidos para una navegación rápida.
Props
Etiqueta de fecha o versión (crea el ID de anclaje).
Texto secundario debajo de la etiqueta.
Etiquetas de categoría mostradas como insignias.
Cadena de fecha ISO (p. ej., "2025-03-15") utilizada para el pubDate del feed RSS. No se muestra visualmente; la label sigue siendo tu texto de visualización.
Feed RSS
Permite que tus lectores se suscriban a las actualizaciones del changelog. Agrega rss: true a cualquier página con componentes Update, y Jamdesk genera automáticamente un feed.xml durante los builds.
---
title: Changelog
rss: true
---Cuando está habilitado:
- Aparece un ícono RSS junto al título de la página, con un enlace al feed
- Se agrega una etiqueta
<link rel="alternate">al<head>para autodescubrimiento, de modo que los lectores de RSS y los navegadores puedan encontrar el feed automáticamente - Cada
<Update>se convierte en un elemento RSS con su etiqueta como título y un enlace de anclaje de vuelta a la entrada
Configurar fechas de publicación
Usa el prop date para establecer el <pubDate> de cada entrada en el feed. Sin date, la entrada aparece en el feed pero sin marca de tiempo.
<Update label="March 2025" date="2025-03-15" tags={["feature"]}>
Added dark mode support across all themes.
</Update>Contenido del feed
Los feeds RSS contienen solo texto plano. El formato Markdown, los componentes MDX, los bloques de código y el HTML se eliminan de la descripción del feed, por lo que escribe tu primera oración como un resumen claro que funcione sin formato.
URL del feed
El feed está disponible en /feed.xml (o /docs/feed.xml si tu sitio usa hostAtDocs).
El feed generado tiene este aspecto:
<?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>Integración con otras herramientas
Los suscriptores pueden usar la URL del feed con cualquier servicio compatible con RSS:
- Slack: agrega la aplicación RSS
/feeda un canal. - Discord: usa MonitoRSS o un bot similar para publicar actualizaciones automáticamente.
- Email: conecta el feed a Zapier o IFTTT para enviar correos a los suscriptores con nuevas entradas.
- Navegadores: Safari, Vivaldi y Firefox (mediante extensiones) admiten RSS de forma nativa.
Puedes agregar rss: true a múltiples páginas. Todas las entradas Update de las páginas habilitadas para RSS se combinan en un único feed.xml para todo el sitio.
Buenas prácticas
Cada etiqueta crea un ID de anclaje, así que usa etiquetas únicas para garantizar un enlazado profundo correcto:
- Usa fechas específicas:
January 10, 2025(no soloJanuary 2025) - Incluye números de versión:
v2.1.0vsv2.0.0 - Las etiquetas duplicadas crearán IDs duplicados, rompiendo la navegación por anclaje
Elige un formato y mantenlo:
January 10, 2025(recomendado)2025-01-10(formato ISO)v2.0.0(para changelogs basados en versiones)
Etiquetas comunes con codificación de color automática:
| Etiqueta | Color | Usar para |
|---|---|---|
breaking | Rojo | Cambios que rompen compatibilidad |
feature / new | Verde | Nueva funcionalidad |
deprecation / deprecated | Ámbar | Funcionalidades obsoletas |
| Otras etiquetas | Gris | Categorías generales como api, fix |
- Empieza con el cambio más importante
- Usa listas con viñetas para múltiples elementos
- Enlaza a documentación detallada para cambios complejos