Changelog
2 min
changelog docid 0rgxak3vybvd660ymmbz7 blocks organize release notes into categorized entries they are useful for communicating new features, improvements, bug fixes, breaking changes, and known issues syntax you can add this component using either markdown or mdx \ changelog{title="release title"} \ changelogitem{type="added" description="what was added"} \ changelogitem{type="fixed" description="what was fixed"} \ \<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> changelog items support the following types added fixed improved broken knownissue mdx example the following example creates a changelog for a product release with multiple categorized updates \<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.