更新日志
2 分
更新日志 块将发行说明组织为分类条目。它们对于传达新功能、改进、错误修复、重大变更以及已知问题非常有用。
语法
您可以使用 Markdown 或 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>更新日志项支持以下类型：
- 已添加
- 固定
- 改进的
- 破损的
- 已知问题
MDX 示例
以下示例为具有多个分类更新的产品版本创建了一个更新日志。
<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.