Skip to content

Commit bc634fd

Browse files
author
sqrtthree
committed
docs: Add document about <API> component
1 parent fd5e333 commit bc634fd

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/zh/1-configurations/1-components.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,30 @@ Contents...
4242

4343
<Block>
4444

45+
## API 组件
46+
47+
`API` 组件是 `<Block>` 组件的一个别名,效果跟 `<Block>` 组件是一样的,只是在特殊场景下语义化更好。
48+
49+
<Example>
50+
51+
使用方式:
52+
53+
```vue
54+
<API>
55+
56+
## Endpoint
57+
58+
GET https://api.github.com/users/:username
59+
60+
</API>
61+
```
62+
63+
</Example>
64+
65+
</Block>
66+
67+
<Block>
68+
4569
## Example 组件
4670

4771
`Example` 组件用于在 `<Block>` 组件中指定右侧深色区域的内容。可以清晰地标识当前部分内容为使用案例。

0 commit comments

Comments
 (0)