Journal des modifications
2 min
Journal des modifications organise les notes de version en entrées classées. Ils sont utiles pour communiquer les nouvelles fonctionnalités, les améliorations, les corrections de bogues, les changements majeurs et les problèmes connus.
Syntaxe
Vous pouvez ajouter ce composant en utilisant soit Markdown soit MDX.
:::Changelog{title="Titre de la version"}
::ChangelogItem{type="added" description="Ce qui a été ajouté"}
::ChangelogItem{type="fixed" description="Ce qui a été corrigé"}
:::Les éléments du journal des modifications prennent en charge les types suivants :
- ajouté
- corrigé
- amélioré
- cassé
- problème connu
Exemple MDX
L’exemple suivant crée un journal des modifications pour une version produit avec plusieurs mises à jour classées.
<Changelog title="v2.0.0 — Multi-Space Support">
<ChangelogItem type="added" description="Multi-space navigation with navbar switcher"/>
<ChangelogItem type="added" description="Per-site appearance overrides (colors, template, fonts)"/>
<ChangelogItem type="improved" description="Hot reload now updates config changes in real time"/>
<ChangelogItem type="fixed" description="Code drawer not appearing on API endpoint pages"/>
<ChangelogItem type="knownIssue" description="Duplicate heading slugs in table of contents"/>
</Changelog>
<Changelog title="v1.5.0 — Docusaurus Support">
<ChangelogItem type="added" description="Auto-detect and render Docusaurus projects"/>
<ChangelogItem type="added" description="Blog directory as separate space"/>
<ChangelogItem type="improved" description="Custom CSS extraction from Docusaurus themes"/>
<ChangelogItem type="fixed" description="TypeScript config files crashing on load"/>
<ChangelogItem type="broken" description="Deprecated: --no-public flag replaced with --private"/>
</Changelog>Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.