Skip to content

Commit 0f533ee

Browse files
author
sqrtthree
committed
docs: Improve document
1 parent b26cc86 commit 0f533ee

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

docs/zh/0-getting-started/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ yarn global add vuepress-theme-api # OR npm install -g vuepress-theme-api
3131

3232
## 应用主题
3333

34-
`VuePress` 默认情况下将会使用自带的默认主题,因此我们需要在 `.vuepress/config.js` 中配置 theme 选项指定为 `vuepress-theme-api` 来应用主题。更多详情请参考 [VuePress | 自定义主题](https://vuepress.vuejs.org/zh/guide/custom-themes.html#%E4%BD%BF%E7%94%A8%E6%9D%A5%E8%87%AA-npm-%E7%9A%84%E4%B8%BB%E9%A2%98)
34+
`VuePress` 默认情况下将会使用自带的默认主题,因此我们需要在 `.vuepress/config.js` 中配置 theme 选项指定为 `vuepress-theme-api` 来应用主题。更多详情请参考 [VuePress | 自定义主题](https://vuepress.vuejs.org/zh/theme/using-a-theme.html)
3535

3636
```js{5}
3737
// .vuepress/config.js

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,6 @@ curl -X POST http://api.example.com/api/auth/login \
109109

110110
</Example>
111111

112-
113112
例如:
114113

115114
````vue
@@ -132,6 +131,8 @@ curl -X GET https://api.github.com/users/sqrthree
132131

133132
</Example>
134133

134+
另外,右侧的 `curl` 内容是可以直接编辑然后发送请求的,修改会立即生效,这在你想要临时想要修改一些参数的时候非常有用。
135+
135136
</Block>
136137

137138
<Block>
File renamed without changes.

docs/zh/1-configurations/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: '基本配置'
1212

1313
`VuePress` 项目必要的配置文件是 `.vuepress/config.js`
1414

15-
参考 [VuePress | 配置文件](https://vuepress.vuejs.org/zh/guide/basic-config.html#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6) 来查看详细信息。
15+
参考 [VuePress | 配置文件](https://vuepress.vuejs.org/zh/guide/basic-config.html) 来查看详细信息。
1616

1717
<Example>
1818

@@ -86,7 +86,7 @@ footer: Open Source on [GitHub](https://github.com/sqrthree/vuepress-theme-api),
8686
- 如果目录下有 `README.md` 文件,则读取其标题作为该分组下第一个导航项。如果文件 `YAML front matter` 中配置了 `title` 项,会采用其值作为标题,否则分析出文章中的第一个标题作为文章标题。如果存在该文件但未配置其标题,则降级为文件目录作为其标题;
8787
- 分析出文章中的所有最 `top` 级标题,作为该分组的导航项;
8888
- 检索该目录下的其他文件,作为该分组的剩余导航项;
89-
- 分析文件中的最 `top` 级标题,做为该文件对应的导航项中的子导航项(默认折叠)。
89+
- 分析其他文件中的最 `top` 级标题,做为该文件对应的导航项中的子导航项(默认折叠)。
9090

9191
### 自定义侧边栏顺序
9292

@@ -363,7 +363,7 @@ module.exports = {
363363
'/': {
364364
lang: 'en-US',
365365
title: 'Hello, World.',
366-
text: 'english',
366+
text: 'English',
367367
description: '📦 🎨 A api-friendly theme for VuePress.',
368368
},
369369
'/zh/': {

0 commit comments

Comments
 (0)