Registro de cambios
2 min
Registro de cambios los bloques organizan las notas de la Versión en entradas categorizadas. Son útiles para comunicar nuevas funciones, mejoras, correcciones de errores, cambios importantes y problemas conocidos.
Sintaxis
Puede agregar este componente usando Markdown o MDX.
<Changelog title="Release Title">
<ChangelogItem type="added" description="What was added"/>
<ChangelogItem type="fixed" description="What was fixed"/>
<ChangelogItem type="improved" description="What was improved"/>
<ChangelogItem type="broken" description="What broke or was deprecated"/>
<ChangelogItem type="knownIssue" description="Known issues"/>
</Changelog>Los elementos del Registro de cambios admiten los siguientes tipos:
- agregado
- corregido
- mejorado
- roto
- knownIssue
Ejemplo MDX
El siguiente ejemplo crea un registro de cambios para una Versión del producto con múltiples actualizaciones categorizadas.
<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.