Skip to content

Commit 9b19d8f

Browse files
liujupingJackLian
liujuping
authored and
JackLian
committed
docs: remove title level from 示例 sections in documentation
1 parent 4025a7d commit 9b19d8f

5 files changed

Lines changed: 23 additions & 22 deletions

File tree

‎docs/docs/api/common.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ executeTransaction(fn: () => void, type: IPublicEnumTransitionType): void;
8282
```
8383
**@since v1.0.16**
8484

85-
##### 示例
85+
**示例**
8686
```typescript
8787
import { common } from '@alilc/lowcode-engine';
8888
import { IPublicEnumTransitionType } from '@alilc/lowcode-types';
@@ -132,7 +132,8 @@ createIntl(instance: string | object): {
132132

133133
**@since v1.0.17**
134134

135-
##### 示例
135+
**示例**
136+
136137
```typescript
137138
import { common } from '@alilc/lowcode-engine';
138139
import enUS from './en-US.json';
@@ -156,7 +157,7 @@ i18n 转换方法
156157
intl(data: IPublicTypeI18nData | string, params?: object): string;
157158
```
158159

159-
##### 示例
160+
**示例**
160161
```
161162
const title = common.utils.intl(node.title)
162163
```

‎docs/docs/api/config.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ sidebar_position: 8
2424
*/
2525
get(key: string, defaultValue?: any): any;
2626
```
27-
#### 示例
27+
**示例**
2828
```typescript
2929
import { config } from '@alilc/lowcode-engine';
3030

@@ -43,7 +43,7 @@ config.get('keyB', { a: 1 });
4343
*/
4444
set(key: string, value: any): void;
4545
```
46-
#### 示例
46+
**示例**
4747
```typescript
4848
import { config } from '@alilc/lowcode-engine';
4949

@@ -63,7 +63,7 @@ config.set('keyC', 1);
6363
has(key: string): boolean;
6464
```
6565

66-
#### 示例
66+
**示例**
6767
```typescript
6868
import { config } from '@alilc/lowcode-engine';
6969

@@ -81,7 +81,7 @@ config.has('keyD');
8181
*/
8282
setConfig(config: { [key: string]: any }): void;
8383
```
84-
#### 示例
84+
**示例**
8585
```typescript
8686
import { config } from '@alilc/lowcode-engine';
8787

@@ -134,7 +134,7 @@ config.getPreference().set(`${panelName}-pinned-status-isFloat`, false, 'skeleto
134134
*/
135135
onceGot(key: string): Promise<any>;
136136
```
137-
#### 示例
137+
**示例**
138138
```typescript
139139
import { config } from '@alilc/lowcode-engine';
140140

@@ -160,7 +160,7 @@ const value = await config.onceGot('keyA');
160160
*/
161161
onGot(key: string, fn: (data: any) => void): () => void;
162162
```
163-
#### 示例
163+
**示例**
164164
```typescript
165165
import { config } from '@alilc/lowcode-engine';
166166

‎docs/docs/api/material.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ setAssets(assets: IPublicTypeAssetsJson): void;
3939
相关类型：[IPublicTypeAssetsJson](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/assets-json.ts)
4040

4141

42-
##### 示例
42+
**示例**
4343
直接在项目中引用 npm 包
4444
```javascript
4545
import { material } from '@alilc/lowcode-engine';
@@ -85,7 +85,7 @@ getAssets(): IPublicTypeAssetsJson;
8585
相关类型：[IPublicTypeAssetsJson](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/assets-json.ts)
8686

8787

88-
##### 示例
88+
**示例**
8989
```typescript
9090
import { material } from '@alilc/lowcode-engine';
9191

@@ -106,7 +106,7 @@ loadIncrementalAssets(incrementalAssets: IPublicTypeAssetsJson): Promise<void>;
106106
```
107107
相关类型：[IPublicTypeAssetsJson](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/assets-json.ts)
108108

109-
##### 示例
109+
**示例**
110110
```typescript
111111
import { material } from '@alilc/lowcode-engine';
112112
import assets1 from '@alilc/mc-assets-<siteId>/assets.json';
@@ -146,7 +146,7 @@ addBuiltinComponentAction(action: IPublicTypeComponentAction): void;
146146
相关类型：[IPublicTypeComponentAction](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/component-action.ts)
147147

148148

149-
##### 示例
149+
**示例**
150150
新增设计扩展位，并绑定事件
151151
```typescript
152152
import { material } from '@alilc/lowcode-engine';
@@ -186,7 +186,7 @@ removeBuiltinComponentAction(name: string): void;
186186
- lock：锁定，不可编辑
187187
- unlock：解锁，可编辑
188188

189-
##### 示例
189+
**示例**
190190
```typescript
191191
import { material } from '@alilc/lowcode-engine';
192192

@@ -222,7 +222,7 @@ modifyBuiltinComponentAction(
222222

223223

224224

225-
##### 示例
225+
**示例**
226226
给原始的 remove 扩展时间添加执行前后的日志
227227
```typescript
228228
import { material } from '@alilc/lowcode-engine';
@@ -335,7 +335,7 @@ getComponentMeta(componentName: string): IPublicModelComponentMeta | null;
335335
```
336336
相关类型：[IPublicModelComponentMeta](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/component-meta.ts)
337337

338-
##### 示例
338+
**示例**
339339
```typescript
340340
import { material } from '@alilc/lowcode-engine';
341341

@@ -356,7 +356,7 @@ material.getComponentMeta('Input');
356356
```
357357
相关类型：[IPublicModelComponentMeta](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/component-meta.ts)
358358

359-
##### 示例
359+
**示例**
360360
```typescript
361361
import { material } from '@alilc/lowcode-engine';
362362

@@ -393,7 +393,7 @@ registerMetadataTransducer(
393393
): void;
394394
```
395395

396-
##### 示例
396+
**示例**
397397
给每一个组件的配置添加高级配置面板，其中有一个是否渲染配置项
398398
```typescript
399399
import { material } from '@alilc/lowcode-engine'
@@ -475,7 +475,7 @@ material.registerMetadataTransducer((transducer) => {
475475
getRegisteredMetadataTransducers(): IPublicTypeMetadataTransducer[];
476476
```
477477

478-
##### 示例
478+
**示例**
479479
```typescript
480480
import { material } from '@alilc/lowcode-engine'
481481

@@ -496,7 +496,7 @@ onChangeAssets(fn: () => void): IPublicTypeDisposable;
496496

497497
相关类型：[IPublicTypeDisposable](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/disposable.ts)
498498

499-
##### 示例
499+
**示例**
500500
```typescript
501501
import { material } from '@alilc/lowcode-engine';
502502

‎docs/docs/api/project.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ addPropsTransducer(
201201
- [IPublicTypePropsTransducer](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/props-transducer.ts)
202202
- [IPublicEnumTransformStage](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/enum/transform-stage.ts)
203203

204-
#### 示例
204+
**示例**
205205
在保存的时候删除每一个组件的 props.hidden
206206
```typescript
207207
import { project } from '@alilc/lowcode-engine';

‎docs/docs/api/simulatorHost.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ sidebar_position: 3
2020
*/
2121
set(key: string, value: any): void;
2222
```
23-
#### 示例
23+
**示例**
2424
设置若干用于画布渲染的变量，比如画布大小、locale 等。
2525

2626
以设置画布大小为例：

0 commit comments

Comments
 (0)