feat: update

hellof2e · Nov 3, 2022 · 1ef0437 · 1ef0437
1 parent 15239f7
commit 1ef0437
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 15 deletions.
diff --git a/.github/workflows/sync-docs.yml b/.github/workflows/sync-docs.yml
@@ -17,8 +17,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-    - run: yarn run bootstrap
-    - run: yarn run link
+    - run: yarn
+    - run: yarn link
     - run: yarn copydocs
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v3

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,17 +11,17 @@ We are very welcome to the community developers to make contributions to Quark D
 First start:
 
 ```bash
-yarn run bootstrap // Install the dependencies of the sub-project
+yarn // Install the dependencies of the sub-project
 
-yarn run link // First execution, mutual dependency soft link
+yarn link // First execution, mutual dependency soft link
 
-npm run dev // Start executing the project
+yarn dev // Start executing the project
 ```
 
 After that, just run the following command:
 
 ```bash
-npm run dev
+yarn dev
 ```
 
 ## Command description (core maintainer release package use)

diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md
@@ -11,9 +11,9 @@
 第一次启动：
 
 ```bash
-yarn run bootstrap // 安装项目的依赖
+yarn // 安装项目的依赖
 
-yarn run link // 第一次执行需要，互相依赖的软链接
+yarn link // 第一次执行需要，互相依赖的软链接
 
 yarn dev // 开始执行工程
 ```

diff --git a/packages/quark/src/cell/demo.vue b/packages/quark/src/cell/demo.vue
@@ -80,7 +80,7 @@ export default createDemo({
 						icon: "展示图标",
 						group: "分组用法",
 						custom: "自定义样式，省略号展示",
-						right: "自定义右侧内容",
+						right: "自定义右侧描述",
 					},
 					title: "这是标题",
 					desc: "描述文字",

diff --git a/packages/quark/src/cell/doc-react.en-US.md b/packages/quark/src/cell/doc-react.en-US.md
@@ -90,7 +90,10 @@ export default () => {
   --cell-title-text-overflow: ellipsis;
 }
 ```
-### Right content
+
+### Customize right description
+
+The description on the right can be customized through Slot (the content of the `Cell` package).
 
 ```tsx
 import { Cell } from '@quarkd/quark-react';

diff --git a/packages/quark/src/cell/doc-react.zh-CN.md b/packages/quark/src/cell/doc-react.zh-CN.md
@@ -89,7 +89,9 @@ export default () => {
   --cell-title-text-overflow: ellipsis;
 }
 ```
-### 自定义右侧内容
+### 自定义右侧描述
+
+通过 Slot（`Cell` 包裹的内容）可以自定义右侧描述。
 
 ```tsx
 import { Cell } from '@quarkd/quark-react';

diff --git a/packages/quark/src/cell/doc.en-US.md b/packages/quark/src/cell/doc.en-US.md
@@ -59,7 +59,10 @@ Set the maximum width of the title, show ellipsis
   --cell-title-text-overflow: ellipsis;
 }
 ```
-### Right content
+
+### Customize right description
+
+The description on the right can be customized through Slot (the content of the `Cell` package).
 
 ```html
 <quark-cell title="Cell title">

diff --git a/packages/quark/src/cell/doc.zh-CN.md b/packages/quark/src/cell/doc.zh-CN.md
@@ -57,7 +57,9 @@ import 'quarkd/lib/cell';
   --cell-title-text-overflow: ellipsis;
 }
 ```
-### 自定义右侧内容
+### 自定义右侧描述
+
+通过 Slot（`Cell` 包裹的内容）可以自定义右侧描述。
 
 ```html
 <quark-cell title="标题">

diff --git a/packages/quark/src/noticebar/doc-react.zh-CN.md b/packages/quark/src/noticebar/doc-react.zh-CN.md
@@ -79,7 +79,7 @@ import { Marquee } from "@quarkd/quark-react"
 |--------------|----------------------------------|
 | left     | 自定义左侧内容              |               
 | text   | 自定义文本                  |   
-| right    | 自定义右侧内容               |    
+| right    | 自定义右侧描述               |    
 
 
 

diff --git a/packages/quark/src/noticebar/doc.zh-CN.md b/packages/quark/src/noticebar/doc.zh-CN.md
@@ -78,7 +78,7 @@ import "quarkd/lib/marquee";
 |--------------|----------------------------------|
 | left     | 自定义左侧内容              |               
 | text   | 自定义文本                  |   
-| right    | 自定义右侧内容               |    
+| right    | 自定义右侧描述               |    
 
 
 ### Event