Passer au contenu principal
Utilisez le composant Update pour afficher des entrées du journal des modifications, des mises à jour de version et des notes de version avec un formatage cohérent.
Exemple
v0.1.1

Exemple de mise à jour

Vous pouvez ajouter ici tout ce que vous voulez, comme une capture d’écran, un extrait de code ou une liste de modifications.
Capture d’écran de la page d’introduction de PearsDB, à titre d’exemple d’image dans un composant Update.

Fonctionnalités

  • Design adaptable
  • Ancre pour chaque mise à jour
  • Entrée de flux RSS générée pour chaque mise à jour

Mode d’emploi

Update example
<Update label="2024-10-11" description="v0.1.0" tags={["Mintlify"]}>
  Ceci est une mise à jour avec un libellé, une description et une étiquette.
</Update>
Utilisez plusieurs composants Update pour créer des journaux des modifications. Les composants Update génèrent automatiquement des entrées de flux RSS. Les entrées contiennent uniquement du Markdown brut : les composants, les code blocks, le code en ligne et les éléments HTML bruts ne sont pas inclus. Si votre mise à jour inclut des composants ou du HTML, utilisez la prop rss pour fournir un texte alternatif aux abonnés RSS.
Custom RSS content
<Update
  label="March 2025"
  description="v2.0.0"
  rss={{
    title: "Mars 2025 - Refonte majeure",
    description: "Refonte complète de l'interface utilisateur avec de nouveaux composants"
  }}
>
  ## Nouveau tableau de bord

  <Frame>
    <img src="/dashboard.png" alt="Nouvelle interface utilisateur du tableau de bord affichant les composants mis à jour." />
  </Frame>

  Découvrez notre tableau de bord repensé avec une navigation améliorée.
</Update>

Props

label
string
required
Label de la mise à jour. Apparaît à gauche de la mise à jour et crée un lien d’ancrage. Les labels doivent être uniques.
tags
string[]
Tags de la mise à jour. Affichés comme filtres dans le panneau latéral droit.
description
string
Description de la mise à jour. Apparaît sous le label et le tag.
rss
object
Les composants Update génèrent automatiquement des entrées de flux RSS. Utilisez la propriété rss pour créer une seule entrée de flux RSS avec un titre et une description personnalisés.Si la propriété n’est pas fournie :
  • Les mises à jour avec des intertitres Markdown créent une entrée de flux RSS distincte pour chaque intertitre.
  • Les mises à jour sans intertitres Markdown créent une seule entrée de flux RSS en utilisant le label comme titre.