首页
/ Dumi 2.4.20 版本发布:优化文档标题处理与代码展示体验

Dumi 2.4.20 版本发布:优化文档标题处理与代码展示体验

2025-06-14 11:41:32作者:秋阔奎Evelyn

Dumi 是一个基于 Umi 的 React 组件研发工具,专注于为开发者提供优秀的文档体验。它特别适合用于组件库开发、工具文档编写等场景,通过简洁的配置和强大的功能,帮助开发者快速构建专业的技术文档网站。

标题属性支持优化

在本次 2.4.20 版本中,Dumi 修复了标题标签中 id 属性的处理问题。现在,当开发者在 markdown 文档中为标题指定 id 属性时,Dumi 会正确保留这些属性。例如:

## 安装指南 {#install}

这样的写法将生成带有指定 id 的标题元素,这对于文档内部跳转和 SEO 优化都非常有帮助。这项改进使得文档的锚点定位更加精准,提升了文档的可访问性和用户体验。

代码块语言标识增强

新版本为代码块添加了语言标识徽章,这是一个显著的视觉改进。当你在文档中插入代码片段时:

```jsx
import React from 'react';
```

Dumi 现在会在代码块右上角显示"JSX"的标签,清晰标识代码语言类型。这一改进使得文档中的代码示例更加专业和易于识别,特别是当文档中包含多种编程语言的代码示例时,读者可以快速了解当前代码块的语言类型。

数组类型处理修复

在自动生成 API 文档的功能中,Dumi 改进了对特定数组类型的处理逻辑。当组件 propTypes 或 TypeScript 类型定义中包含复杂数组类型时,如:

interface Props {
  items: Array<{ name: string; value: number }>;
}

新版本能够更准确地解析和展示这类类型定义,确保自动生成的 API 文档更加完整和准确。这对于维护大型组件库的开发者来说尤为重要,因为它能保证文档与代码实现保持同步。

升级建议

对于正在使用 Dumi 的项目,建议通过以下命令升级到最新版本:

npm install dumi@2.4.20
# 或
yarn add dumi@2.4.20

这次更新属于小版本迭代,主要包含功能优化和问题修复,不会引入破坏性变更。新加入的语言标识徽章功能可能会轻微影响现有文档的视觉布局,但不会改变其功能行为。

Dumi 持续关注开发者体验,这些小而美的改进累积起来,使得它成为 React 生态中文档工具的优秀选择。无论是个人项目还是企业级组件库,Dumi 都能提供专业、高效的文档解决方案。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
179
263
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
871
515
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
131
184
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
346
380
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
334
1.09 K
harmony-utilsharmony-utils
harmony-utils 一款功能丰富且极易上手的HarmonyOS工具库,借助众多实用工具类,致力于助力开发者迅速构建鸿蒙应用。其封装的工具涵盖了APP、设备、屏幕、授权、通知、线程间通信、弹框、吐司、生物认证、用户首选项、拍照、相册、扫码、文件、日志,异常捕获、字符、字符串、数字、集合、日期、随机、base64、加密、解密、JSON等一系列的功能和操作,能够满足各种不同的开发需求。
ArkTS
31
0
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.08 K
0
kernelkernel
deepin linux kernel
C
22
5
WxJavaWxJava
微信开发 Java SDK,支持微信支付、开放平台、公众号、视频号、企业微信、小程序等的后端开发,记得关注公众号及时接受版本更新信息,以及加入微信群进行深入讨论
Java
829
22
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
603
58