首页
/ 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 都能提供专业、高效的文档解决方案。

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

热门内容推荐

最新内容推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
153
1.98 K
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
505
42
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
194
279
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
992
395
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
938
554
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
332
11
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
146
191
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
75
70