Atualização
Entradas de changelog em linha do tempo, com datas, descrições e tags de categoria integradas ao índice para facilitar a navegação.
O componente Update cria entradas de changelog em formato de linha do tempo que se integram automaticamente ao seu índice de conteúdo. Cada entrada pode ter um rótulo de data, uma descrição e tags de categoria, sendo adequada para páginas "Novidades", changelogs de API e notas de versão.
Use Update para:
- Documentar versões com números de versão ou datas
- Criar changelogs que os leitores podem navegar pelo índice
- Anunciar recursos com tags categorizadas (novo, correção, incompatível)
Criou um changelog com essas entradas? Você pode exibi-lo no seu próprio produto com um botão "What's new?" e um ponto indicador de itens não lidos. Consulte Incorporar seu changelog.
Uso básico
Adicionado suporte ao modo escuro em todos os temas.
<Update label="January 10, 2025">
Added support for dark mode across all themes.
</Update>Com descrição
Adicione contexto abaixo da data:
Mudança incompatível
A função getData() agora exige um objeto de opções.
<Update label="January 5, 2025" description="Breaking change">
The `getData()` function now requires an options object.
</Update>Com tags
Categorize as entradas com tags:
- Removida a opção obsoleta
legacyMode - Fluxo de autenticação atualizado
<Update label="December 20, 2024" tags={["breaking", "api"]}>
- Removed deprecated `legacyMode` option
- Updated authentication flow
</Update>Várias entradas
Empilhe componentes Update para criar um changelog completo:
Nova funcionalidade de exportação para os formatos PDF e CSV.
Corrigido o tratamento de fusos horários em publicações agendadas.
Os endpoints da API v1 agora estão obsoletos. Migre para v2 até março de 2025.
Links de âncora e índice
Cada Update gera um ID de âncora a partir do rótulo (label="January 10, 2025" cria #january-10-2025). Os rótulos também aparecem no índice de conteúdo para facilitar a navegação.
Propriedades
Rótulo de data ou versão (cria um ID de âncora).
Texto secundário abaixo do rótulo.
Tags de categoria exibidas como selos.
String de data ISO (por exemplo, "2025-03-15") usada no pubDate do feed RSS. Não é renderizada visualmente; o label continua sendo o texto exibido.
Feed RSS
Permita que seus leitores assinem as atualizações do changelog. Adicione rss: true a qualquer página com componentes Update, e o Jamdesk gerará automaticamente um feed.xml durante os builds.
---
title: Changelog
rss: true
---Quando ativado:
- Um ícone RSS aparece ao lado do título da página, com um link para o feed
- Uma tag
<link rel="alternate">é adicionada ao<head>para descoberta automática, permitindo que leitores RSS e navegadores encontrem o feed automaticamente - Cada
<Update>se torna um item RSS com seu rótulo como título e um link de âncora de volta para a entrada
Definir datas de publicação
Use a propriedade date para definir o <pubDate> de cada entrada no feed. Sem date, a entrada aparece no feed, mas sem carimbo de data e hora.
<Update label="March 2025" date="2025-03-15" tags={["feature"]}>
Added dark mode support across all themes.
</Update>Conteúdo do feed
Os feeds RSS contêm apenas texto simples. Formatação Markdown, componentes MDX, blocos de código e HTML são removidos da descrição do feed; portanto, escreva a primeira frase como um resumo claro que funcione sem formatação.
URL do feed
O feed está disponível em /feed.xml (ou /docs/feed.xml se o site usar hostAtDocs).
O feed gerado é semelhante a este:
<?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>Integração com outras ferramentas
Os assinantes podem usar a URL do feed com qualquer serviço compatível com RSS:
- Slack: adicione o aplicativo RSS
/feeda um canal. - Discord: use o MonitoRSS ou um bot semelhante para publicar atualizações automaticamente.
- E-mail: conecte o feed ao Zapier ou ao IFTTT para enviar e-mails aos assinantes quando houver novas entradas.
- Navegadores: Safari, Vivaldi e Firefox (por meio de extensões) oferecem suporte nativo a RSS.
Você pode adicionar rss: true a várias páginas. Todas as entradas Update das páginas com RSS ativado são combinadas em um único feed.xml para todo o site.
Práticas recomendadas
Cada rótulo cria um ID de âncora; portanto, use rótulos exclusivos para garantir links diretos corretos:
- Use datas específicas:
January 10, 2025(não apenasJanuary 2025) - Inclua números de versão:
v2.1.0em vez dev2.0.0 - Rótulos duplicados criarão IDs duplicados, interrompendo a navegação por âncoras
Escolha um formato e mantenha-o:
January 10, 2025(recomendado)2025-01-10(formato ISO)v2.0.0(para changelogs baseados em versão)
Tags comuns com codificação automática de cores:
| Tag | Cor | Use para |
|---|---|---|
breaking | Vermelho | Mudanças incompatíveis |
feature / new | Verde | Novas funcionalidades |
deprecation / deprecated | Âmbar | Funcionalidades obsoletas |
| Outras tags | Cinza | Categorias gerais, como api, fix |
- Comece pela mudança mais importante
- Use marcadores para vários itens
- Adicione links para a documentação detalhada em mudanças complexas