Merge pull request #109 from ant-design/doc/update

📝 docs: update i18n docs
ant-design · Nov 28, 2023 · b248876 · b248876
2 parents 12444f5 + 25a3dd5
commit b248876
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 35 deletions.
diff --git a/src/ActionGroup/demos/basic.tsx b/src/ActionGroup/demos/basic.tsx
@@ -1,6 +1,3 @@
-/**
- * title: 基础使用
- */
 import { ActionGroup } from '@ant-design/pro-editor';
 
 export default () => {

diff --git a/src/ActionGroup/demos/config.tsx b/src/ActionGroup/demos/config.tsx
@@ -1,7 +1,3 @@
-/**
- * title: 配置使用
- * description: 通过配置 `items` 渲染整个内容，你可以通过在 items 声明 type 为 divider 来渲染一个分隔符
- */
 import { CopyOutlined, DragOutlined, ZoomInOutlined, ZoomOutOutlined } from '@ant-design/icons';
 import { ActionGroup } from '@ant-design/pro-editor';
 import { message } from 'antd';

diff --git a/src/ActionGroup/demos/custom.tsx b/src/ActionGroup/demos/custom.tsx
@@ -1,7 +1,3 @@
-/**
- * title: 自定义
- * description: 通过 `render` 可以自定义渲染特殊的操作内容
- */
 import { ActionGroup, ActionIcon, ActionIconGroupItemType } from '@ant-design/pro-editor';
 import { Card, Input, Rate, Switch } from 'antd';
 

diff --git a/src/ActionGroup/demos/dropMenu.tsx b/src/ActionGroup/demos/dropMenu.tsx
@@ -1,8 +1,3 @@
-/**
- * title: dropdown
- * description: 通过配置 `dropdownMenu` 可以在尾部渲染一个下拉内容
- */
-
 import { CopyOutlined, DragOutlined, ZoomInOutlined, ZoomOutOutlined } from '@ant-design/icons';
 import { ActionGroup } from '@ant-design/pro-editor';
 import { message } from 'antd';

diff --git a/src/ActionGroup/demos/type.tsx b/src/ActionGroup/demos/type.tsx
@@ -1,7 +1,4 @@
 import { CopyOutlined, DragOutlined, ZoomInOutlined, ZoomOutOutlined } from '@ant-design/icons';
-/**
- * title: 模式配置
- */
 import { ActionGroup } from '@ant-design/pro-editor';
 import { InputNumber, Segmented, Space } from 'antd';
 import { useState } from 'react';

diff --git a/src/ActionGroup/demos/withPanel.tsx b/src/ActionGroup/demos/withPanel.tsx
@@ -1,8 +1,3 @@
-/**
- * title: 浮动面板中使用
- * description: 配合 DraggablePanel 可以使得整个面板可浮动拖拽
- */
-
 import type { Position } from '@ant-design/pro-editor';
 import { ActionGroup, DraggablePanel } from '@ant-design/pro-editor';
 import { useLocalStorageState } from 'ahooks';

diff --git a/src/ActionGroup/index.en-US.md b/src/ActionGroup/index.en-US.md
@@ -17,7 +17,12 @@ When you need a general panel to carry a series of global tools such as "full sc
 
 ## Code Demo
 
-<code src="./demos/basic.tsx" ></code> <code src="./demos/config.tsx" ></code> <code src="./demos/dropMenu.tsx" ></code> <code src="./demos/type.tsx" ></code> <code src="./demos/custom.tsx" ></code> <code src="./demos/withPanel.tsx" iframe></code>
+<code src="./demos/basic.tsx" ></code>
+<code src="./demos/config.tsx" title='Configuration Usage' description= "Render the entire content by configuring `items`, and you can render a separator by declaring type as divider in items"></code>
+<code src="./demos/dropMenu.tsx" title="Dropdown" description="Render a dropdown content at the end by configuring `dropdownMenu`"></code>
+<code src="./demos/type.tsx" title="Mode Configuration"></code>
+<code src="./demos/custom.tsx" title='Customization' description= "Customize the rendering of special operational content using `render`"></code>
+<code src="./demos/withPanel.tsx" iframe title="Usage in Floating Panel" description="Combine with DraggablePanel to make the entire panel float and draggable"></code>
 
 ## API
 

diff --git a/src/ActionGroup/index.zh-CN.md b/src/ActionGroup/index.zh-CN.md
@@ -15,11 +15,13 @@ demo:
 ## 代码演示
 
 <code src="./demos/basic.tsx" ></code>
-<code src="./demos/config.tsx" ></code>
-<code src="./demos/dropMenu.tsx" ></code>
-<code src="./demos/type.tsx" ></code>
-<code src="./demos/custom.tsx" ></code>
-<code src="./demos/withPanel.tsx" iframe></code>
+<code src="./demos/config.tsx" title='配置使用' description= "通过配置 `items` 渲染整个内容，你可以通过在 items 声明 type 为 divider 来渲染一个分隔符"></code>
+<code src="./demos/dropMenu.tsx" title="dropdown" description="通过配置 `dropdownMenu` 可以在尾部渲染一个下拉内容"></code>
+<code src="./demos/type.tsx" title="模式配置"
+
+> </code>
+> <code src="./demos/custom.tsx" title='自定义' description= "通过 `render` 可以自定义渲染特殊的操作内容" ></code>
+> <code src="./demos/withPanel.tsx" iframe title="浮动面板中使用" description="配合 DraggablePanel 可以使得整个面板可浮动拖拽"></code>
 
 ## API
 

diff --git a/src/ActionIcon/demos/preset.tsx b/src/ActionIcon/demos/preset.tsx
@@ -1,7 +1,3 @@
-/**
- * title: 预设
- * description: 一些编辑器常用按钮的预设
- */
 import { CollapseAction, DeleteAction, EditAction, HandleAction } from '@ant-design/pro-editor';
 import { Space } from 'antd';
 

diff --git a/src/ActionIcon/index.en-US.md b/src/ActionIcon/index.en-US.md
@@ -14,7 +14,8 @@ It is a encapsulation of antd Button, allowing icons to have responsive button a
 
 ## Code Example
 
-<code src="./demos/basic.tsx" ></code> <code src="./demos/preset.tsx" ></code>
+<code src="./demos/basic.tsx" ></code>
+<code title='Default' src="./demos/preset.tsx" description='Presets for some commonly used buttons in the editor'></code>
 
 ## API