Skip to content

Commit

Permalink
docs: update changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
pointhalo committed Nov 30, 2024
1 parent 19f5fc0 commit 3ca11e4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
4 changes: 4 additions & 0 deletions content/start/changelog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,16 @@ Semi 版本号遵循 **Semver** 规范(主版本号-次版本号-修订版本
- 【Feat】
- Table 新增 shouldCellUpdate API,用于自定义单元格的是否需重新渲染 [#2584](https://github.com/DouyinFE/semi-design/pull/2584)
- Cascader 支持 checkRelation API 用于设置选项关联性 [#2582](https://github.com/DouyinFE/semi-design/issues/2582)
- Highlight Highlight 支持针对不同关键字使用不同高亮样式 [#2600](https://github.com/DouyinFE/semi-design/pull/2600)
- `@douyinfe/semi-icons-lab` 增加新图标: IconChart、IconChat、IconCodeHighlight、IconLottie、IconMarkdown、IconPincode、IconVersionOne、IconWebComponents、IconJsonViewer [#2583](https://github.com/DouyinFE/semi-design/pull/2583)
- 【Chore】
- 修改 @douyinfe/semi-icons 中 svg path 数字精度,保留两位小数,全量图标 min 包体积 450 kb -> 278kb [#2583](https://github.com/DouyinFE/semi-design/pull/2583)
- 修复 Lottie 组件类型报错问题 [#2593](https://github.com/DouyinFE/semi-design/pull/2593)
- 【Perf】
- Select renderOption 相关的逻辑推迟在候选项展示后再执行, 减少不必要的渲染 [#2598](https://github.com/DouyinFE/semi-design/issues/2598)
- 【Fix】
- 修复 js 省略 的Typography 未设置宽度时,省略计算错误问题 [#2591](https://github.com/DouyinFE/semi-design/issues/2591)
- 修复 MarkdownRender 的 table 在一些 markdown 内容语法不正确时候的报错, 增加兜底尝试 [#2590](https://github.com/DouyinFE/semi-design/pull/2590)

#### 🎉 2.70.1 (2024-11-25)
- 【Fix】
Expand Down
13 changes: 8 additions & 5 deletions content/start/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,13 @@ icon: doc-gettingstarted
order: 2
---

## 1、安装 Semi
Semi Design 由抖音前端团队负责维护,提供 React 版本开箱即用的70+ 组件、 Figam Variant UI Kit
你可在任意 React 项目中引入使用 (新项目更推荐通过 Rsbuild、CreateReactApp、Vite 新建),当前支持搭配 React v16、v17、v18 版本使用

若你需要使用 prefixCls、主题、CSS Layer等编译时定制能力的场景,我们更推荐使用 Webpack 或 Rspack/Rsbuild 作为工程化构建方案
(字节跳动用户,若使用的是公司内部相关工程化方案,配置请查阅飞书文档:<a href="https://bytedance.larkoffice.com/wiki/FaRwweDLmigrD0k8wLgcDaQtnbb" target="_blank">Semi工程化 FAQ</a>)

Semi 支持搭配 React v16、v17、v18 版本使用
## 1、安装 Semi

```bash
# 使用 npm
Expand All @@ -25,7 +29,6 @@ pnpm add @douyinfe/semi-ui
## 2、使用组件

在 Webpack、Rspack、create-react-app 或 Vite 项目中使用时,无需进行任何编译项配置,直接使用即可。构建时所有相关资源均会按需打包
(字节跳动用户,若使用的是公司内部相关工程化方案,配置请查阅飞书文档:<a href="https://bytedance.larkoffice.com/wiki/FaRwweDLmigrD0k8wLgcDaQtnbb" target="_blank">Semi工程化 FAQ</a>)

```jsx
import React, { Component } from 'react';
Expand All @@ -34,8 +37,8 @@ import { Button, Toast } from '@douyinfe/semi-ui';
const SemiApp = () => {
return (
<Button onClick={() => Toast.warning({ content: 'welcome' })}>Hello Semi</Button>
)
}
);
};
```

> 推荐在项目中引入 [reset.css](https://www.npmjs.com/package/reset-css),它可以重置浏览器自带的默认样式,避免不同UA之间的样式差异。
Expand Down
2 changes: 1 addition & 1 deletion src/components/PageAnchor/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const makeAnchorOfToken = data => {

const PageAnchor = props => {
const { data = [], slug } = props;
const skipCondition = ['accessibility', 'dark-mode', 'customize-theme', 'content-guidelines', 'getting-started', 'design-to-code', 'chart'].some(item => slug.includes(item));
const skipCondition = ['introduction', 'accessibility', 'dark-mode', 'customize-theme', 'content-guidelines', 'getting-started', 'design-to-code', 'chart'].some(item => slug.includes(item));

let flag = false;
const makeAnchor = data => {
Expand Down

0 comments on commit 3ca11e4

Please sign in to comment.