Skip to content

docs: 更新介绍部分内容 #3324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Miles-hxy merged 1 commit into from
Aug 6, 2025
Merged

docs: 更新介绍部分内容 #3324

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/sites/sites-react/doc/docs/taro/intro-react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# NutUI-React

NutUI-React 组件库，适用于 React 技术栈的 H5 应用，开箱即用，帮助研发快速开发用户界面，提升开发效率，改善开发体验。
NutUI-React 组件库，基于 Taro，使用 React 技术栈开发小程序应用，开箱即用，帮助研发快速开发用户界面，提升开发效率，改善开发体验。

## 特性

- 🚀 80+ 高质量组件，覆盖移动端主流场景
- 💪 支持一套代码同时开发多端小程序+H5
- 📖 基于京东APP 15.0 视觉规范
- 🍭 支持按需引用
- 📖 详尽的文档和示例
- 💪 支持 TypeScript
- 💪 支持服务端渲染（Next.js）
- 💪 支持服务端渲染（测试阶段）
- 🍭 支持定制主题
- 🌍 国际化支持
- 🍭 单元测试覆盖率超过 85%，保障稳定性
- 🍭 单元测试覆盖率超过 80%，保障稳定性
- 📖 提供 Sketch 设计资源

## 扫码体验
Expand All @@ -23,7 +24,7 @@ NutUI-React 组件库，适用于 React 技术栈的 H5 应用，开箱即用，

| 版本 | 支持的框架 | 视觉规范 | 兼容 |
| --- | --- | --- | --- |
| @nutui/nutui-react <img src="https://img.shields.io/npm/v/@nutui/nutui-react" /> | React 17\18 | 京东 APP 15.0 规范 | 现代浏览器以 Chrome >= 51、iOS >= 10.0 |
| @nutui/nutui-react-taro <img src="https://img.shields.io/npm/v/@nutui/nutui-react" /> | React 17\18 | 京东 APP 15.0 规范 | 现代浏览器以 Chrome >= 51、iOS >= 10.0 |

@coderabbitai coderabbitai Bot Aug 6, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

npm 徽章链接与包名不一致且缺少 alt 文本

  1. 行内徽章仍指向旧包 @nutui/nutui-react，而表格已改为 @nutui/nutui-react-taro，显示的版本号可能误导读者。
  2. <img> 标签未提供 alt 属性，违反无障碍规范（markdownlint MD045 提示）。

可按以下 diff 修正：

-| @nutui/nutui-react-taro <img src="https://img.shields.io/npm/v/@nutui/nutui-react" /> | React 17\18 | 京东 APP 15.0 规范 | 现代浏览器以 Chrome >= 51、iOS >= 10.0 |
+| @nutui/nutui-react-taro <img src="https://img.shields.io/npm/v/@nutui/nutui-react-taro" alt="npm version (@nutui/nutui-react-taro)" /> | React 17\18 | 京东 APP 15.0 规范 | 现代浏览器以 Chrome >= 51、iOS >= 10.0 |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| @nutui/nutui-react-taro <img src="https://img.shields.io/npm/v/@nutui/nutui-react" /> | React 17\18 | 京东 APP 15.0 规范 | 现代浏览器以 Chrome >= 51、iOS >= 10.0 |
| @nutui/nutui-react-taro <img src="https://img.shields.io/npm/v/@nutui/nutui-react-taro" alt="npm version (@nutui/nutui-react-taro)" /> | React 17\18 | 京东 APP 15.0 规范 | 现代浏览器以 Chrome >= 51、iOS >= 10.0 |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

27-27: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents 
In src/sites/sites-react/doc/docs/taro/intro-react.md at line 27, the npm badge
link and package name are inconsistent and the img tag lacks an alt attribute.
Update the badge URL to point to the correct package @nutui/nutui-react-taro
instead of @nutui/nutui-react, and add a meaningful alt attribute to the img tag
to comply with accessibility standards.


对于一些低版本的浏览器，需要相应的 Ployfill，建议使用 @babel/preset-environment 来解决浏览器兼容问题。NutUI-React 提供的包并未进行过多的语法转换，所以需要将 NutUI-React 包含到编译阶段。

Expand Down
Loading