Jamdesk Documentation logo

Atualização

Entradas de changelog em formato de linha do tempo, com datas, descrições e tags de categoria. Integra-se ao sumário para navegação.

O componente Update cria entradas de changelog em formato de linha do tempo. As entradas aparecem no sumário. Uma entrada pode ter um rótulo de data, uma descrição e tags de categoria. Use-o para páginas de "Novidades", changelogs de API e notas de versão.

Use Update quando:

  • Documentar versões com números de versão ou datas
  • Criar changelogs que os leitores possam navegar pelo sumário
  • Anunciar recursos com tags categorizadas (novo, correção, breaking)

Mostre o changelog dentro do seu produto com um botão "O que há de novo?" e um ponto de não lido. Veja Incorpore seu changelog.

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>

Com descrição

Adicione contexto abaixo da data:

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>

Com tags

Categorize as entradas com tags:

breakingapi
  • Removed deprecated legacyMode option
  • Updated authentication flow
<Update label="December 20, 2024" tags={["breaking", "api"]}>

- Removed deprecated `legacyMode` option
- Updated authentication flow

</Update>

Várias entradas

Empilhe componentes Update para formar um changelog completo:

feature

New export functionality for PDF and CSV formats.

fix

Fixed timezone handling in scheduled posts.

deprecation

The v1 API endpoints are now deprecated. Migrate to v2 by March 2025.

Cada Update gera um ID de âncora a partir do seu rótulo (label="January 10, 2025" cria #january-10-2025). Os rótulos também aparecem no sumário para navegação rápida.

Propriedades

string

Rótulo de data ou versão (cria o ID de âncora).

string

Texto secundário abaixo do rótulo.

string[]

Tags de categoria exibidas como badges.

string

String de data ISO (ex.: "2025-03-15") usada para o pubDate do feed RSS. Não é renderizada visualmente; o label continua sendo o texto de exibição.

Feed RSS

Adicione rss: true a qualquer página com componentes Update. A Jamdesk gera um feed.xml durante os builds. Os leitores assinam o feed para receber atualizações do changelog.

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

Quando habilitado:

  • Um ícone RSS aparece ao lado do título da página, com link para o feed
  • Uma tag <link rel="alternate"> é adicionada ao <head> para descoberta automática por leitores RSS e navegadores
  • Cada <Update> se torna um item RSS com seu rótulo como título e um link de âncora de volta à 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/hora.

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

Added dark mode support across all themes.

</Update>

Conteúdo do feed

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. Escreva a primeira frase como um resumo que faça sentido sem formatação.

URL do feed

O feed está disponível em /feed.xml (ou /docs/feed.xml se o seu site usar hostAtDocs).

O feed gerado tem esta aparência:

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

Adicione a URL do feed a qualquer serviço compatível com RSS:

  • Slack: adicione o app RSS /feed a 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 a cada nova entrada.
  • Navegadores: Safari, Vivaldi e Firefox (via extensões) oferecem suporte nativo a RSS.

Adicione rss: true a mais de uma página, se necessário. A Jamdesk combina as entradas de Update de todas as páginas com RSS habilitado em um único feed.xml para todo o site.

Práticas recomendadas

Cada rótulo cria um ID de âncora. Mantenha os rótulos exclusivos para que os links diretos funcionem:

  • Use datas específicas: January 10, 2025 (e não apenas January 2025)
  • Inclua números de versão: v2.1.0 vs v2.0.0
  • Rótulos duplicados criam IDs duplicados e quebram os links de âncora

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 de cores automática:

TagCorUse para
breakingVermelhoMudanças que quebram compatibilidade
feature / newVerdeNovas funcionalidades
deprecation / deprecatedÂmbarRecursos descontinuados
Outras tagsCinzaCategorias gerais como api, fix
  • Comece pela mudança mais importante
  • Use marcadores para vários itens
  • Linke para a documentação detalhada em mudanças complexas

O que vem a seguir?

Visão geral dos componentes

Veja todos os componentes disponíveis

Fundamentos de MDX

Aprenda a usar componentes no MDX