Skip to content

【DOC】修复文档错误、优化脚本 #3993

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
merged 2 commits into from
Oct 16, 2025
Merged

【DOC】修复文档错误、优化脚本 #3993

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd6a8eb
chore: update css generation script
novlan1 Oct 15, 2025
d16381e
chore: update script
novlan1 Oct 15, 2025
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
1 change: 0 additions & 1 deletion packages/components/dropdown-menu/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ Name | Default Value | Description
--td-dropdown-menu-height | 96rpx | -
--td-dropdown-menu-icon-size | 40rpx | -
--td-dropdown-body-max-height | 560rpx | -
--td-dropdown-menu-bg-color | @bg-color-container | -
--td-tree-bg-color | @bg-color-container | -
--td-tree-item-active-color | @brand-color | -
--td-tree-item-font-size | 32rpx | -
Expand Down
1 change: 0 additions & 1 deletion packages/components/dropdown-menu/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,6 @@ t-class-footer | 底部样式类
--td-dropdown-menu-height | 96rpx | -
--td-dropdown-menu-icon-size | 40rpx | -
--td-dropdown-body-max-height | 560rpx | -
--td-dropdown-menu-bg-color | @bg-color-container | -
--td-tree-bg-color | @bg-color-container | -
--td-tree-item-active-color | @brand-color | -
--td-tree-item-font-size | 32rpx | -
Expand Down
10 changes: 10 additions & 0 deletions packages/components/form-item/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,13 @@ name | String | - | \- | N
required-mark | Boolean | undefined | \- | N
rules | Array | - | Typescript：`Array<FormRule>` | N
show-error-message | Boolean | undefined | \- | N

### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
-- | -- | --
--td-form-item-horizontal-padding | 32rpx | -
--td-form-item-justify-content | space-between | -
--td-form-item-label-width | 160rpx | -
--td-form-item-vertical-padding | 32rpx | -
10 changes: 10 additions & 0 deletions packages/components/form-item/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,13 @@ name | String | - | 表单字段名称 | N
required-mark | Boolean | undefined | 是否显示必填符号（*），优先级高于 Form.requiredMark | N
rules | Array | - | 【开发中】 | N
show-error-message | Boolean | undefined | 校验不通过时，是否显示错误提示信息，优先级高于 `Form.showErrorMessage` | N

### CSS Variables

组件提供了下列 CSS 变量，可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
--td-form-item-horizontal-padding | 32rpx | -
--td-form-item-justify-content | space-between | -
--td-form-item-label-width | 160rpx | -
--td-form-item-vertical-padding | 32rpx | -
14 changes: 14 additions & 0 deletions packages/components/form/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,17 @@ telnumber | String | - | \- | N
url | String | - | \- | N
validator | String | - | \- | N
whitespace | String | - | \- | N

### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
-- | -- | --
--td-form-bg-color | @bg-color-container | -
--td-form-border-radius | 0 | -
--td-form-padding | 0 | -
--td-form-readonly-bg-color | @bg-color-secondarycontainer | -
--td-form-item-horizontal-padding | 32rpx | -
--td-form-item-justify-content | space-between | -
--td-form-item-label-width | 160rpx | -
--td-form-item-vertical-padding | 32rpx | -
14 changes: 14 additions & 0 deletions packages/components/form/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,17 @@ telnumber | String | - | 手机号号码校验不通过时的表单项显示文
url | String | - | 链接校验规则不通过时的表单项显示文案，全局配置默认是：`'请输入正确的${name}'` | N
validator | String | - | 自定义校验规则校验不通过时的表单项显示文案，全局配置默认是：'${name}不符合要求' | N
whitespace | String | - | 值为空格校验不通过时表单项显示文案，全局配置默认是：`'${name}不能为空` | N

### CSS Variables

组件提供了下列 CSS 变量，可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
--td-form-bg-color | @bg-color-container | -
--td-form-border-radius | 0 | -
--td-form-padding | 0 | -
--td-form-readonly-bg-color | @bg-color-secondarycontainer | -
--td-form-item-horizontal-padding | 32rpx | -
--td-form-item-justify-content | space-between | -
--td-form-item-label-width | 160rpx | -
--td-form-item-vertical-padding | 32rpx | -
2 changes: 1 addition & 1 deletion packages/components/indexes-anchor/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Name | Default Value | Description
--td-indexes-anchor-font-size | 28rpx | -
--td-indexes-anchor-line-height | 44rpx | -
--td-indexes-anchor-padding | 8rpx 32rpx | -
--td-indexes-anchor-top | 0 | -
--td-indexes-anchor-top | 0 | -
2 changes: 1 addition & 1 deletion packages/components/indexes-anchor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ t-class | 根节点样式类
--td-indexes-anchor-font-size | 28rpx | -
--td-indexes-anchor-line-height | 44rpx | -
--td-indexes-anchor-padding | 8rpx 32rpx | -
--td-indexes-anchor-top | 0 | -
--td-indexes-anchor-top | 0 | -
32 changes: 16 additions & 16 deletions packages/components/progress/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,21 +80,21 @@ t-class-label | 标签样式类
### CSS Variables

组件提供了下列 CSS 变量，可用于自定义样式。
名称 | 默认值 | 描述
名称 | 默认值 | 描述
-- | -- | --
--td-progress-info-dark-color | @text-color-primary | -
--td-progress-info-light-color | @text-color-anti | -
--td-progress-inner-bg-color-active | @bg-color-container | -
--td-progress-inner-bg-color-error | @error-color | -
--td-progress-inner-bg-color-success | @success-color | -
--td-progress-inner-bg-color-warning | @warning-color | -
--td-progress-circle-inner-bg-color | @text-color-anti | -
--td-progress-circle-label-font-size | 40rpx | -
--td-progress-circle-label-font-weight | 700 | -
--td-progress-circle-label-line-height | 56rpx | -
--td-progress-circle-width | 224rpx | -
--td-progress-inner-bg-color | @brand-color | -
--td-progress-line-stroke-width | 12rpx | -
--td-progress-stroke-circle-width | 12rpx | -
--td-progress-stroke-plump-width | 40rpx | -
--td-progress-info-dark-color | @text-color-primary | -
--td-progress-info-light-color | @text-color-anti | -
--td-progress-inner-bg-color-active | @bg-color-container | -
--td-progress-inner-bg-color-error | @error-color | -
--td-progress-inner-bg-color-success | @success-color | -
--td-progress-inner-bg-color-warning | @warning-color | -
--td-progress-circle-inner-bg-color | @text-color-anti | -
--td-progress-circle-label-font-size | 40rpx | -
--td-progress-circle-label-font-weight | 700 | -
--td-progress-circle-label-line-height | 56rpx | -
--td-progress-circle-width | 224rpx | -
--td-progress-inner-bg-color | @brand-color | -
--td-progress-line-stroke-width | 12rpx | -
--td-progress-stroke-circle-width | 12rpx | -
--td-progress-stroke-plump-width | 40rpx | -
--td-progress-track-bg-color | @bg-color-component | -
1 change: 0 additions & 1 deletion packages/components/side-bar/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ Name | Default Value | Description
--td-side-bar-height | 100% | -
--td-side-bar-width | 206rpx | -
--td-side-bar-active-color | @brand-color | -
--td-side-bar-bg-color | @bg-color-secondarycontainer | -
--td-side-bar-border-radius | 18rpx | -
--td-side-bar-color | @text-color-primary | -
--td-side-bar-disabled-color | @text-color-disabled | -
Expand Down
1 change: 0 additions & 1 deletion packages/components/side-bar/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@ value | String / Number | - | 当前选项的值 | N
--td-side-bar-height | 100% | -
--td-side-bar-width | 206rpx | -
--td-side-bar-active-color | @brand-color | -
--td-side-bar-bg-color | @bg-color-secondarycontainer | -
--td-side-bar-border-radius | 18rpx | -
--td-side-bar-color | @text-color-primary | -
--td-side-bar-disabled-color | @text-color-disabled | -
Expand Down
1 change: 0 additions & 1 deletion packages/components/skeleton/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ Name | Default Value | Description
--td-skeleton-animation-flashed | rgba(90%, 90%, 90%, 0.3) | -
--td-skeleton-animation-gradient | rgba(0, 0, 0, 4%) | -
--td-skeleton-bg-color | @bg-color-secondarycontainer | -
--td-skeleton-circle-border-radius | @radius-circle | -
--td-skeleton-circle-height | 96rpx | -
--td-skeleton-rect-border-radius | @radius-default | -
--td-skeleton-rect-height | 32rpx | -
Expand Down
1 change: 0 additions & 1 deletion packages/components/skeleton/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ t-class-row | 列样式类
--td-skeleton-animation-flashed | rgba(90%, 90%, 90%, 0.3) | -
--td-skeleton-animation-gradient | rgba(0, 0, 0, 4%) | -
--td-skeleton-bg-color | @bg-color-secondarycontainer | -
--td-skeleton-circle-border-radius | @radius-circle | -
--td-skeleton-circle-height | 96rpx | -
--td-skeleton-rect-border-radius | @radius-default | -
--td-skeleton-rect-height | 32rpx | -
Expand Down
1 change: 0 additions & 1 deletion packages/components/slider/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ Name | Default Value | Description
--td-slider-capsule-bar-width | 48rpx | -
--td-slider-capsule-line-heihgt | 36rpx | -
--td-slider-default-color | @bg-color-component | -
--td-slider-default-color | @bg-color-component-disabled | -
--td-slider-disabled-color | @brand-color-disabled | -
--td-slider-disabled-text-color | @text-color-disabled | -
--td-slider-dot-bg-color | #fff | -
Expand Down
1 change: 0 additions & 1 deletion packages/components/slider/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,6 @@ t-class-cursor | 游标样式类
--td-slider-capsule-bar-width | 48rpx | -
--td-slider-capsule-line-heihgt | 36rpx | -
--td-slider-default-color | @bg-color-component | -
--td-slider-default-color | @bg-color-component-disabled | -
--td-slider-disabled-color | @brand-color-disabled | -
--td-slider-disabled-text-color | @text-color-disabled | -
--td-slider-dot-bg-color | #fff | -
Expand Down
2 changes: 0 additions & 2 deletions packages/components/tab-bar/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@ Name | Default Value | Description
--td-tab-bar-round-shadow | @shadow-3 | -
--td-tab-bar-active-bg | @brand-color-light | -
--td-tab-bar-active-color | @brand-color | -
--td-tab-bar-bg-color | @bg-color-container | -
--td-tab-bar-border-color | @border-color | -
--td-tab-bar-color | @text-color-primary | -
--td-tab-bar-height | 80rpx | -
--td-tab-bar-hover-bg-color | rgba(0, 0, 0, 0.05) | -
Expand Down
2 changes: 0 additions & 2 deletions packages/components/tab-bar/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,6 @@ value | String / Number | - | 标识符 | N
--td-tab-bar-round-shadow | @shadow-3 | -
--td-tab-bar-active-bg | @brand-color-light | -
--td-tab-bar-active-color | @brand-color | -
--td-tab-bar-bg-color | @bg-color-container | -
--td-tab-bar-border-color | @border-color | -
--td-tab-bar-color | @text-color-primary | -
--td-tab-bar-height | 80rpx | -
--td-tab-bar-hover-bg-color | rgba(0, 0, 0, 0.05) | -
Expand Down
50 changes: 2 additions & 48 deletions packages/components/tag/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ Name | Default Value | Description
--td-tag-medium-height | 48rpx | -
--td-tag-medium-icon-size | 28rpx | -
--td-tag-medium-padding | 16rpx - 1px | -
--td-tag-outline-bg-color | @bg-color-container | -
--td-tag-primary-color | @brand-color | -
--td-tag-primary-light-color | @brand-color-light | -
--td-tag-round-border-radius | 999px | -
Expand All @@ -99,51 +100,4 @@ Name | Default Value | Description
--td-tag-success-color | @success-color | -
--td-tag-success-light-color | @success-color-1 | -
--td-tag-warning-color | @warning-color | -
--td-tag-warning-light-color | @warning-color-1 | -
ant
@tag-outline-bg-color: var(--td-tag-outline-bg-color | @bg-color-container | -
ant = dark | @@theme-color, @@theme-light-color | -
ant = dark | @text-color-anti, @@theme-color | -
ant = light | @@theme-light-color, @@theme-color | -
ant) {
@themes: default | primary, success, warning, dange | -
--td-tag-danger-color | @error-color | -
--td-tag-danger-light-color | @error-color-1 | -
--td-tag-default-color | @bg-color-component | -
--td-tag-default-font-color | @text-color-primary | -
--td-tag-default-light-color | @bg-color-secondarycontainer | -
--td-tag-disabled-background-color | @bg-color-component-disabled | -
--td-tag-disabled-border-color | @component-border | -
--td-tag-disabled-color | @text-color-disabled | -
--td-tag-extra-large-font-size | @font-size-base | -
--td-tag-extra-large-height | 80rpx | -
--td-tag-extra-large-icon-size | 32rpx | -
--td-tag-extra-large-padding | 32rpx - 1px | -
--td-tag-large-font-size | @font-size-base | -
--td-tag-large-height | 56rpx | -
--td-tag-large-icon-size | 32rpx | -
--td-tag-large-padding | 16rpx - 1px | -
--td-tag-mark-border-radius | @tag-round-border-radius | -
--td-tag-medium-font-size | @font-size-s | -
--td-tag-medium-height | 48rpx | -
--td-tag-medium-icon-size | 28rpx | -
--td-tag-medium-padding | 16rpx - 1px | -
--td-tag-primary-color | @brand-color | -
--td-tag-primary-light-color | @brand-color-light | -
--td-tag-round-border-radius | 999px | -
--td-tag-small-font-size | @font-size | -
--td-tag-small-height | 40rpx | -
--td-tag-small-icon-size | 24rpx | -
--td-tag-small-padding | 12rpx - 1px | -
--td-tag-square-border-radius | 8rpx | -
--td-tag-success-color | @success-color | -
--td-tag-success-light-color | @success-color-1 | -
--td-tag-warning-color | @warning-color | -
--td-tag-warning-light-color | @warning-color-1 | -
ant
@tag-outline-bg-color: var(--td-tag-outline-bg-color | @bg-color-container | -
ant = dark | @@theme-color, @@theme-light-color | -
ant = dark | @text-color-anti, @@theme-color | -
ant = light | @@theme-light-color, @@theme-color | -
ant) {
@themes: default | primary, success, warning, dange | -
--td-tag-warning-light-color | @warning-color-1 | -
50 changes: 2 additions & 48 deletions packages/components/tag/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ t-class | 根节点样式类
--td-tag-medium-height | 48rpx | -
--td-tag-medium-icon-size | 28rpx | -
--td-tag-medium-padding | 16rpx - 1px | -
--td-tag-outline-bg-color | @bg-color-container | -
--td-tag-primary-color | @brand-color | -
--td-tag-primary-light-color | @brand-color-light | -
--td-tag-round-border-radius | 999px | -
Expand All @@ -147,51 +148,4 @@ t-class | 根节点样式类
--td-tag-success-color | @success-color | -
--td-tag-success-light-color | @success-color-1 | -
--td-tag-warning-color | @warning-color | -
--td-tag-warning-light-color | @warning-color-1 | -
ant
@tag-outline-bg-color: var(--td-tag-outline-bg-color | @bg-color-container | -
ant = dark | @@theme-color, @@theme-light-color | -
ant = dark | @text-color-anti, @@theme-color | -
ant = light | @@theme-light-color, @@theme-color | -
ant) {
@themes: default | primary, success, warning, dange | -
--td-tag-danger-color | @error-color | -
--td-tag-danger-light-color | @error-color-1 | -
--td-tag-default-color | @bg-color-component | -
--td-tag-default-font-color | @text-color-primary | -
--td-tag-default-light-color | @bg-color-secondarycontainer | -
--td-tag-disabled-background-color | @bg-color-component-disabled | -
--td-tag-disabled-border-color | @component-border | -
--td-tag-disabled-color | @text-color-disabled | -
--td-tag-extra-large-font-size | @font-size-base | -
--td-tag-extra-large-height | 80rpx | -
--td-tag-extra-large-icon-size | 32rpx | -
--td-tag-extra-large-padding | 32rpx - 1px | -
--td-tag-large-font-size | @font-size-base | -
--td-tag-large-height | 56rpx | -
--td-tag-large-icon-size | 32rpx | -
--td-tag-large-padding | 16rpx - 1px | -
--td-tag-mark-border-radius | @tag-round-border-radius | -
--td-tag-medium-font-size | @font-size-s | -
--td-tag-medium-height | 48rpx | -
--td-tag-medium-icon-size | 28rpx | -
--td-tag-medium-padding | 16rpx - 1px | -
--td-tag-primary-color | @brand-color | -
--td-tag-primary-light-color | @brand-color-light | -
--td-tag-round-border-radius | 999px | -
--td-tag-small-font-size | @font-size | -
--td-tag-small-height | 40rpx | -
--td-tag-small-icon-size | 24rpx | -
--td-tag-small-padding | 12rpx - 1px | -
--td-tag-square-border-radius | 8rpx | -
--td-tag-success-color | @success-color | -
--td-tag-success-light-color | @success-color-1 | -
--td-tag-warning-color | @warning-color | -
--td-tag-warning-light-color | @warning-color-1 | -
ant
@tag-outline-bg-color: var(--td-tag-outline-bg-color | @bg-color-container | -
ant = dark | @@theme-color, @@theme-light-color | -
ant = dark | @text-color-anti, @@theme-color | -
ant = light | @@theme-light-color, @@theme-color | -
ant) {
@themes: default | primary, success, warning, dange | -
--td-tag-warning-light-color | @warning-color-1 | -
14 changes: 14 additions & 0 deletions packages/components/watermark/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,17 @@ name | type | default | description | required
-- | -- | -- | -- | --
is-grayscale | Boolean | false | \- | N
url | String | - | \- | N

### CSS Variables

The component provides the following CSS variables, which can be used to customize styles.
Name | Default Value | Description
-- | -- | --
--watermark-left-0 | --watermark-left-0 | -
--watermark-left-25 | --watermark-left-25 | -
--watermark-left-50 | --watermark-left-50 | -
--watermark-left-75 | --watermark-left-75 | -
--watermark-top-0 | --watermark-top-0 | -
--watermark-top-25 | --watermark-top-25 | -
--watermark-top-50 | --watermark-top-50 | -
--watermark-top-75 | --watermark-top-75 | -
14 changes: 14 additions & 0 deletions packages/components/watermark/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,17 @@ text | String | - | 水印文本内容 | N
-- | -- | -- | -- | --
is-grayscale | Boolean | false | 水印图片是否需要灰阶显示 | N
url | String | - | 水印图片源地址，为了显示清楚，建议导出 2 倍或 3 倍图 | N

### CSS Variables

组件提供了下列 CSS 变量，可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
--watermark-left-0 | --watermark-left-0 | -
--watermark-left-25 | --watermark-left-25 | -
--watermark-left-50 | --watermark-left-50 | -
--watermark-left-75 | --watermark-left-75 | -
--watermark-top-0 | --watermark-top-0 | -
--watermark-top-25 | --watermark-top-25 | -
--watermark-top-50 | --watermark-top-50 | -
--watermark-top-75 | --watermark-top-75 | -
2 changes: 1 addition & 1 deletion packages/tdesign-miniprogram/site/docs/dark-mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ spline: design-mode

## 实现方案

TDesign Minirogram 基于 Design Token 变量和媒体查询 `prefers-color-scheme` 实现了深色模式。默认情况下，每个组件自带了组件级别 light 样式变量，无需手动引入。如需使用深色模式，请按照以下步骤操作。
TDesign Miniprogram 基于 Design Token 变量和媒体查询 `prefers-color-scheme` 实现了深色模式。默认情况下，每个组件自带了组件级别 light 样式变量，无需手动引入。如需使用深色模式，请按照以下步骤操作。

## 使用方式

Expand Down
Loading
Loading