Skip to content

Commit 4e769a6

Browse files
committed
Complete proofreading
1 parent e64fd82 commit 4e769a6

File tree

11 files changed

+57
-60
lines changed

11 files changed

+57
-60
lines changed

Diff for: docs/guide/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ Each markdown file is compiled into HTML with [markdown-it](https://github.com/m
3030

3131
VuePress is still a work in progress. There are a few things that it currently does not support but are planned:
3232

33-
- Multi-Language Support
3433
- Algolia DocSearch Integration
3534
- Blogging support
3635

Diff for: docs/zh/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ footer: MIT Licensed | Copyright © 2018-present Evan You
2020
yarn global add vuepress # 或者:npm install -g vuepress
2121

2222
# 新建一个 markdown 文件
23-
echo "# Hello VuePress!" > README.md
23+
echo '# Hello VuePress!' > README.md
2424

2525
# 开始写作
2626
vuepress dev .
@@ -30,5 +30,5 @@ vuepress build .
3030
```
3131

3232
::: warning NODE VERSION
33-
请确保你的 Node.js 的版本大于 8。
33+
请确保你 Node.js 的版本大于 8。
3434
:::

Diff for: docs/zh/config/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ module.exports = {
9090
当然,仅仅只在你的网站部署后能用 SSL 的时候开启它,因为 service worker 只能在 HTTPs 的链接下注册。
9191
:::
9292

93-
## Theming
93+
## 主题
9494

9595
### theme
9696

@@ -143,7 +143,7 @@ module.exports = {
143143
}
144144
```
145145

146-
## Build Pipeline
146+
## 构建流程
147147

148148
### postcss
149149

@@ -184,7 +184,7 @@ module.exports = {
184184
}
185185
```
186186

187-
## Browser Compatibility
187+
## 浏览器兼容性
188188

189189
### evergreen
190190

Diff for: docs/zh/default-theme-config/README.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ sidebar: auto
88
所有列在这一页的选项仅对默认的主题生效。如果你在使用一个自定义主题,选项可能会有不同。
99
:::
1010

11-
## Homepage
11+
## 首页
1212

13-
默认的主题提供了一个 homepage 的布局 (用于 [这个网站的主页](/zh/))。想要使用它,需要在你的根级 `README.md`[YAML front matter](../guide/markdown.html#yaml-front-matter) 指定 `home: true`。以下是这个网站实际使用的数据:
13+
默认的主题提供了一个首页(Homepage)的布局 (用于 [这个网站的主页](/zh/))。想要使用它,需要在你的根级 `README.md`[YAML front matter](../guide/markdown.md#yaml-front-matter) 指定 `home: true`。以下是这个网站实际使用的数据:
1414

1515
``` yaml
1616
---
@@ -31,7 +31,7 @@ footer: MIT Licensed | Copyright © 2018-present Evan You
3131

3232
任何 `YAML front matter` 之后额外的内容将会以普通的 markdown 被渲染,并插入到 `features` 的后面。
3333

34-
## Navbar Links
34+
## 导航栏
3535

3636
你可以通过 `themeConfig.nav` 增加一些导航链接:
3737

@@ -81,9 +81,9 @@ module.exports = {
8181
}
8282
```
8383

84-
## Sidebar
84+
## 侧边栏
8585

86-
想要使 sidebar 生效,需要设置 `themeConfig.sidebar`,基本的配置,需要一个包含了多个链接的数组:
86+
想要使 侧边栏(Sidebar)生效,需要配置 `themeConfig.sidebar`,基本的配置,需要一个包含了多个链接的数组:
8787

8888
``` js
8989
// .vuepress/config.js
@@ -100,9 +100,9 @@ module.exports = {
100100

101101
你可以省略 `.md` 拓展名,同时以 `/` 结尾的路径将会被视为 `*/README.md`,这个链接的文字将会被自动获取到(无论你是声明为页面的第一个 header,还是明确地在 `YAML front matter` 中指定页面的标题)。如果你想要显示地指定链接的文字,使用一个格式为 `[link, text]` 的数组。
102102

103-
### Nested Header Links
103+
### 嵌套的标题链接
104104

105-
默认情况下,侧边栏(sidebar)会自动地显示由当前页面标的题(headers)组成的的链接,并按照页面本身的结构进行嵌套,你可以通过 `themeConfig.sidebarDepth` 来修改它的行为。默认的深度是 `1`,它将提取到 `h2` 的标题,设置成 `0` 将会禁用标题(headers)链接,同时,最大的深度为 `2`,它将同时提取 `h2``h3` 标题。
105+
默认情况下,侧边栏会自动地显示由当前页面标的题(headers)组成的的链接,并按照页面本身的结构进行嵌套,你可以通过 `themeConfig.sidebarDepth` 来修改它的行为。默认的深度是 `1`,它将提取到 `h2` 的标题,设置成 `0` 将会禁用标题(headers)链接,同时,最大的深度为 `2`,它将同时提取 `h2``h3` 标题。
106106

107107
也可以使用 `YAML front matter` 来为某个页面重写此值:
108108

@@ -112,9 +112,9 @@ sidebarDepth: 2
112112
---
113113
```
114114

115-
### Sidebar Groups
115+
### 侧边栏分组
116116

117-
你可以通过使用**对象**来将侧边栏(sidebar)划分成多个组
117+
你可以通过使用**对象**来将侧边栏划分成多个组
118118

119119
``` js
120120
// .vuepress/config.js
@@ -137,11 +137,11 @@ module.exports = {
137137
}
138138
```
139139

140-
侧边栏(sidebar)的组默认是可折叠的,你可以设置 `collapsable: false` 来让一个组永远都是展开状态。
140+
侧边栏的每个子组默认是可折叠的,你可以设置 `collapsable: false` 来让一个组永远都是展开状态。
141141

142-
### Multiple Sidebars
142+
### 多个侧边栏
143143

144-
如果你想为不同的页面组来显示不同的侧边栏(sidebar),首先,将你的页面文件组织成下述的目录结构:
144+
如果你想为不同的页面组来显示不同的侧边栏,首先,将你的页面文件组织成下述的目录结构:
145145

146146
```
147147
.
@@ -156,7 +156,7 @@ module.exports = {
156156
└─ four.md
157157
```
158158

159-
接着,遵循以下的侧边栏(sidebar)配置
159+
接着,遵循以下的侧边栏配置
160160

161161
``` js
162162
// .vuepress/config.js
@@ -180,29 +180,29 @@ module.exports = {
180180
}
181181
```
182182

183-
### Auto Sidebar for Single Pages
183+
### 自动生成侧栏
184184

185-
如果你希望自动生成一个仅仅包含了当前页面标题(header)链接的侧边栏(sidebar),你可以通过 `YAML front matter` 来实现:
185+
如果你希望自动生成一个仅仅包含了当前页面标题(headers)链接的侧边栏,你可以通过 `YAML front matter` 来实现:
186186

187187
``` yaml
188188
---
189189
sidebar: auto
190190
---
191191
```
192192

193-
### Disabling the Sidebar
193+
### 禁用侧边栏
194194

195-
你可以通过 `YAML front matter` 来禁用指定页面的侧边栏(sidebar)
195+
你可以通过 `YAML front matter` 来禁用指定页面的侧边栏:
196196

197197
``` yaml
198198
---
199199
sidebar: false
200200
---
201201
```
202202

203-
## Prev / Next Links
203+
## / 下一篇链接
204204

205-
上一篇和下一篇文章的链接将会自动地根据当前页面的侧边栏(sidebar)的顺序来获取。你也可以使用 `YAML front matter` 来明确地重写或者禁用它:
205+
上一篇和下一篇文章的链接将会自动地根据当前页面的侧边栏的顺序来获取。你也可以使用 `YAML front matter` 来明确地重写或者禁用它:
206206

207207
``` yaml
208208
---
@@ -211,7 +211,7 @@ next: false
211211
---
212212
```
213213

214-
## GitHub Repo and Edit Links
214+
## Github 和编辑链接
215215

216216
当你提供了 `themeConfig.repo` 选项,将会自动在每个页面的导航栏生成生成一个 GitHub 链接,以及在页面的底部生成一个 `"Edit this page"` 链接。
217217

@@ -231,7 +231,7 @@ module.exports = {
231231
}
232232
```
233233

234-
## Simple CSS Override
234+
## 简单的 CSS 覆盖
235235

236236
如果你只是希望应用一些简单的 overrides 到默认主题的样式上,你可以创建一个 `.vuepress/override.styl` 文件,这是一个 [Stylus](http://stylus-lang.com/) 文件,但是你仍然可以使用普通的 CSS 语法。
237237

@@ -245,9 +245,9 @@ $borderColor = #eaecef
245245
$codeBgColor = #282c34
246246
```
247247

248-
## Custom Layout for Specific Pages
248+
## 特定页面的自定义布局
249249

250-
默认情况下,每个 `*.md` 文件将会被渲染在一个 `<div class="page">` 容器中,同时还有侧边栏(sidebar)、自动生成的编辑链接,以及上一篇 / 下一篇文章的链接。如果你想要使用一个完全自定义的组件来代替当前的页面(而只保留导航栏),你可以再次使用 `YAML front matter` 来指定这个组件。
250+
默认情况下,每个 `*.md` 文件将会被渲染在一个 `<div class="page">` 容器中,同时还有侧边栏、自动生成的编辑链接,以及上 / 下一篇文章的链接。如果你想要使用一个完全自定义的组件来代替当前的页面(而只保留导航栏),你可以再次使用 `YAML front matter` 来指定这个组件。
251251

252252
``` yaml
253253
---

Diff for: docs/zh/guide/README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# 介绍
22

3-
VuePress 由两部分组成:一个是由 Vue 驱动的极简主题系统带来的静态网站生成器,一个是为书写技术而优化的默认主题,它的诞生初衷是为了助力 Vue 及其子项目书写文档的需求。
3+
VuePress 由两部分组成:一个是由 Vue 驱动的极简主题系统带来的静态网站生成器,一个是为书写技术文档而优化的默认主题,它的诞生初衷是为了助力 Vue 及其子项目书写文档的需求。
44

5-
每一个由 VuePress 生成的页面都有自己预渲染好的 HTML,因此带来了非常好的加载性能和搜索引擎优化(SEO)。同时,一旦页面被加载,Vue 将接管这些静态内容,并将其转换成一个完整的单页应用程序(SPA),其他的页面都将在用户浏览到的时候按需加载。
5+
每一个由 VuePress 生成的页面都有自己预渲染好的 HTML,也因此带来了非常好的加载性能和搜索引擎优化(SEO)。同时,一旦页面被加载,Vue 将接管这些静态内容,并将其转换成一个完整的单页应用(SPA),其他的页面都将在用户浏览到的时候按需加载。
66

77
## 它是如何工作的?
88

@@ -14,7 +14,7 @@ VuePress 由两部分组成:一个是由 Vue 驱动的极简主题系统带来
1414

1515
- [内置的 Markdown 拓展](./markdown.md),为技术文档而生
1616
- [在 Markdown 文件使用 Vue 组件的能力](./using-vue.md)
17-
- [Vue 驱动的自定义主题系统](./custom-themes)
17+
- [Vue 驱动的自定义主题系统](./custom-themes.md)
1818
- 支持 PWA
1919
- 集成了 Google Analytics
2020
- 一个默认的主题包含:
@@ -24,13 +24,12 @@ VuePress 由两部分组成:一个是由 Vue 驱动的极简主题系统带来
2424
- 可以自定义的导航栏(navbar)和侧边栏(sidebar)
2525
- 自动生成的 GitHub 链接和页面的编辑链接
2626

27-
## Todo Features
27+
## Todo
2828

2929
VuePress 仍然处于开发中,这里有一些目前还不支持、但已经在计划中的特性:
3030

31-
- 多语言的支持
32-
- 集成 Algolia DocSearch
33-
- 对博客的支持
31+
- Algolia DocSearch 的集成
32+
- 博客系统
3433

3534
欢迎你的 Contribution!
3635

Diff for: docs/zh/guide/assets.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# 静态资源
22

3-
## Relative URLs
3+
## 相对路径
44

5-
所有的 Markdown 文件都会被 webpack 编译成 Vue 组件,因此你可以,并且**应该更倾向于**使用相对路径来引用所有的静态资源
5+
所有的 Markdown 文件都会被 webpack 编译成 Vue 组件,因此你可以,并且**应该更倾向于**使用相对路径(Relative URLs)来引用所有的静态资源
66

77
``` md
88
![An image](./image.png)
@@ -31,20 +31,20 @@ module.exports = {
3131
}
3232
```
3333

34-
## Public Files
34+
## 公共文件
3535

3636
有时,你可能需要提供一个静态资源,但是它们并不直接被你的任何一个 markdown 文件或者主题组件引用 —— 举例来说,favicons 和 PWA 的图标,在这种情形下,你可以将它们放在 `.vuepress/public` 中, 它们最终会被复制到生成的静态文件夹中。
3737

38-
## Base URL
38+
## 基础路径
3939

4040
如果你的网站会被部署到一个**非根路径**,你将需要在 `.vuepress/config.js` 中设置 `base`,举例来说,如果你打算将你的网站部署到 `https://foo.github.io/bar/`,那么 `base` 的值就应该被设置为 `"/bar/"` (应当总是以斜杠开始,并以斜杠结束)。
4141

42-
有了基础路径,如果你希望引用一张放在 `.vuepress/public` 中的图片,你需要使用这样路径:`/bar/image.png`,然而,一旦某一天你决定去修改 `base`,这样的路径引用将会显得异常脆弱。为了解决这个问题,VuePress 提供了内置的一个 helper `$withBase`(它被注入到了 Vue 的原型上),可以帮助你生成正确的路径:
42+
有了基础路径(Base URL),如果你希望引用一张放在 `.vuepress/public` 中的图片,你需要使用这样路径:`/bar/image.png`,然而,一旦某一天你决定去修改 `base`,这样的路径引用将会显得异常脆弱。为了解决这个问题,VuePress 提供了内置的一个 helper `$withBase`(它被注入到了 Vue 的原型上),可以帮助你生成正确的路径:
4343

4444
``` vue
4545
<img :src="$withBase('/foo.png')" alt="foo">
4646
```
4747

48-
值得一提的是,你不仅可以在你组件中使用上述的语法,在 Markdown 文件中亦是如此。
48+
值得一提的是,你不仅可以在你的 Vue 组件中使用上述的语法,在 Markdown 文件中亦是如此。
4949

50-
补充一句,一个 `base` 路径一旦被设置,它将会自动地作为前缀插入到 `.vuepress/config.js` 中所有以 `/` 开始的资源路径中。
50+
最后补充一句,一个 `base` 路径一旦被设置,它将会自动地作为前缀插入到 `.vuepress/config.js` 中所有以 `/` 开始的资源路径中。

Diff for: docs/zh/guide/basic-config.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 配置文件
44

5-
如果没有任何配置,这个网站将会是非常局限的,用户也无法在你的网站上自由导航。为了更好地自定义你的网站,让我们首先在你的文档目录下创建一个 `.vuepress` 目录,所有 VuePress 相关的文件将会被放在这里
5+
如果没有任何配置,这个网站将会是非常局限的,用户也无法在你的网站上自由导航。为了更好地自定义你的网站,让我们首先在你的文档目录下创建一个 `.vuepress` 目录,所有 VuePress 相关的文件都将会被放在这里
66

77
一个 VuePress 网站必要的配置文件是 `.vuepress/config.js`,它应该导出一个 JavaScript 对象:
88

@@ -13,21 +13,21 @@ module.exports = {
1313
}
1414
```
1515

16-
如果你运行起开发服务器,你应该能看到一个页面,它包含一个页头,里面包含一个标题和一个搜索框。VuePress 内置了基于 headers 的搜索 —— 它自动为所有页面的标题(`h1`,或者是通过 `YAML front matter` 设置的 `title`)`h2``h3` 构建了一个简单的搜索索引
16+
对于上述的配置,如果你运行起 dev server,你应该能看到一个页面,它包含一个页头,里面包含一个标题和一个搜索框。VuePress 内置了基于 headers 的搜索 —— 它会自动为所有页面的标题`h2``h3` 构建起一个简单的搜索索引
1717

1818
参见 [配置](../config/) 来查看所有可配置的选项。
1919

2020

2121
## 主题配置
2222

23-
一个 VuePress 主题应该负责整个网站的布局和交互细节。VuePress 自带了一个默认的主题(正是你现在所看到的),它是为技术文档而设计的。同时,默认主题提供了一些选项,让你可以去自定义导航栏(navbar)、 侧边栏(sidebar)和 homepage 等,详情请参见 [默认主题](../default-theme-config/)
23+
一个 VuePress 主题应该负责整个网站的布局和交互细节。VuePress 中,目前自带了一个默认的主题(正是你现在所看到的),它是为技术文档而设计的。同时,默认主题提供了一些选项,让你可以去自定义导航栏(navbar)、 侧边栏(sidebar)和 首页(homepage 等,详情请参见 [默认主题](../default-theme-config/)
2424

2525
如果你想开发一个自定义主题,可以参考 [自定义主题](./custom-themes.md)
2626

2727

2828
## 应用级别的优化
2929

30-
由于 VuePress 是一个标准的 Vue 应用,你可以通过创建一个 `.vuepress/enhanceApp.js` 文件来做一些应用级别的优化,当该文件存在的时候,会被导入到应用内部。`enhanceApp.js` 应该 `export default` 一个钩子函数,并接受一个包含了一些应用级别属性的对象作为参数。你可以使用这个钩子来安装一些附加的 Vue 插件注册全局组件,或者增加额外的路由钩子等:
30+
由于 VuePress 是一个标准的 Vue 应用,你可以通过创建一个 `.vuepress/enhanceApp.js` 文件来做一些应用级别的优化,当该文件存在的时候,会被导入到应用内部。`enhanceApp.js` 应该 `export default` 一个钩子函数,并接受一个包含了一些应用级别属性的对象作为参数。你可以使用这个钩子来安装一些附加的 Vue 插件注册全局组件,或者增加额外的路由钩子等:
3131

3232
```js
3333
export default ({

Diff for: docs/zh/guide/custom-themes.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
主题组件受到同样的 [浏览器的 API 访问限制](./using-vue.md#browser-api-access-restrictions)
55
:::
66

7-
VuePress 使用单文件组件来构建自定义主题。想要开发一个自定义主题,首先在你的文档根目录新建一个 `.vuepress/theme` 文件夹,然后新建一个 `Layout.vue` 文件:
7+
VuePress 使用单文件组件来构建自定义主题。想要开发一个自定义主题,首先在你的文档根目录新建一个 `.vuepress/theme` 文件夹,然后再创建一个 `Layout.vue` 文件:
88

99
```
1010
.
@@ -24,7 +24,7 @@ VuePress 使用单文件组件来构建自定义主题。想要开发一个自
2424
``` json
2525
{
2626
"title": "VuePress",
27-
"description": "Vue-powered Static Site Generator",
27+
"description": "Vue 驱动的静态网站生成器",
2828
"base": "/",
2929
"pages": [
3030
{
@@ -37,7 +37,7 @@ VuePress 使用单文件组件来构建自定义主题。想要开发一个自
3737
}
3838
```
3939

40-
`title`, `description``base` 会从 `.vuepress/config.js` 中对应的的字段复制过来,而 `pages` 是一个包含了每个页面元数据对象的数据,包括它的路径、页面标题(明确地通过 [YAML front matter](./markdown.html#yaml-front-matter) 指定,或者通过该页面的第一个标题取到),以及所有源文件中的 `YAML front matter` 的数据。
40+
`title`, `description``base` 会从 `.vuepress/config.js` 中对应的的字段复制过来,而 `pages` 是一个包含了每个页面元数据对象的数据,包括它的路径、页面标题(明确地通过 [YAML front matter](./markdown.md#yaml-front-matter) 指定,或者通过该页面的第一个标题取到),以及所有源文件中的 `YAML front matter` 的数据。
4141

4242
下面的这个对象是你正在看的这个页面的 `$page` 的值:
4343

Diff for: docs/zh/guide/getting-started.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ vuepress build .
2020

2121
## 现有项目
2222

23-
如果你想在一个现有项目中使用 VuePress,同时想要保留项目已有中的文档,此时你应该将 VuePress 作为本地依赖。下述的安装流程,你同样可以使用持续集成工具,或者一些开源服务,如 Netlify,来帮助你在每次更新代码时自动部署。
23+
如果你想在一个现有项目中使用 VuePress,同时想要在该项目中保存文档,此时你应该将 VuePress 作为本地依赖。下述的安装流程,你同样可以使用持续集成工具,或者一些开源服务,如 Netlify,来帮助你在每次更新代码时自动部署。
2424

2525
``` bash
2626
# 将 VuePress 作为一个本地依赖安装
@@ -51,13 +51,13 @@ npx vuepress dev docs
5151
}
5252
```
5353

54-
于是你就可以这样开始你的写作了:
54+
于是,你就可以这样开始你的写作了:
5555

5656
``` bash
5757
yarn docs:dev # 或者:npm run docs:dev
5858
```
5959

60-
要生成静态资源时,则运行
60+
要生成静态资源时,运行
6161

6262
``` bash
6363
yarn docs:build # 或者:npm run docs:build

0 commit comments

Comments
 (0)