Block
组件主要用于在本页所使用的布局中划分页面结构。每个 Block
组件为一个内容分组。方便你能够自由灵活地把控页面结构。
使用方式:
<Block>
Contents...
</Block>
Example
组件用于在 <Block>
组件中指定右侧深色区域的内容。可以清晰地标识当前部分内容为使用案例。
使用方式:
<Block>
Contents...
<Example>
Some examples...
</Example>
</Block>
CURL
组件是一个非常有用的组件。主要用于在编写 API 时更好的显示 curl
命令时使用。
例如下面的内容将会渲染成右侧的形式:
<CURL>
```bash
curl -X POST https://api.example.com/v1/auth/login \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [plugin:define] value of MOCK_TOKEN is not defined in env.' \
--data '{
"username": "my-username",
"password": "my-password"
}'
```
</CURL>
CURL
组件会在组件下方自动生成一个按钮,当点击按钮时,会通过分析 curl
命令内的参数,通过 Ajax
发送请求到对应的地址上。并将其请求信息输出到信息面板上。方便进行快速测试和预览。
curl -X POST http://api.example.com/api/auth/login \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [plugin:define] value of MOCK_TOKEN is not defined in env.' \
--data '{
"username": "my-username",
"password": "my-password"
}'
例如:
<CURL>
```bash
curl -X GET https://api.github.com/users/sqrthree
```
</CURL>
curl -X GET https://api.github.com/users/sqrthree
Button 组件可以使用在任何页面的任何地方。你可以用来指向一个链接,或是一些特殊的内容。
支持的参数如下:
Name | Type | Description | Default |
---|---|---|---|
to | String | 链接地址 | "" |
size | String | 按钮大小,可选值有 small | large | "" |
light | Boolean | 是否采用亮色主题 | false |
使用下面的代码即可放置一个按钮:
<Button>默认状态</Button>
效果如下:
站内跳转:
<Button to="/zh/">首页</Button>
效果如下:
首页更多使用案例:
<Button light>亮色主题</Button>
<Button to="https://github.com/sqrthree/vuepress-theme-api" light>指定为一个链接</Button>
<Button size="small" light>不同的 size</Button>
Section
组件是一种特殊的布局形式,主要用于 首页。具体效果可参考 首页 | 为 RESTful API 而生。
Name | Type | Description | Default |
---|---|---|---|
theme | String | 主题颜色,可选值有 dark | light | "dark" |
center | Boolean | 内容是否居中 | true |
enhanceMode | Boolean | 是否启用增强模式 | true |
增强模式
增强模式是指该 Section
组件突破父级元素宽度限制,达到和浏览器窗口宽度一致的效果。
首页中使用的配置案例为:
<Section>
## 为 RESTful API 而生
一个简洁易用的 VuePress 主题。
开箱即用,你需要做的只是安装它,然后写吧。
<Button type="light" to="/getting-started/">开始出发</Button>
</Section>