Dumi 2.4.20 版本发布:优化文档标题处理与代码展示体验
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 都能提供专业、高效的文档解决方案。
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0231
GLM-5.2智谱开源 GLM-5.2,这是针对长文本任务的最新旗舰模型。相较于前代产品 GLM-5.1,它在长文本任务处理能力上实现了显著飞跃,并且首次在稳定的 100 万 token 上下文中提供这一能力。Jinja00
JoyAI-VL-Interaction-Preview京东开源首个开源、视觉驱动的实时交互模型——它能实时监控视频流,并自主决定何时发言、保持沉默或委托任务。Jinja00
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0150
kornia🐍 空间人工智能的几何计算机视觉库Python02
PaddleParallel Distributed Deep Learning: Machine Learning Framework from Industrial Practice (『飞桨』核心框架,深度学习&机器学习高性能单机、分布式训练和跨平台部署)C++02