Skip to content

Commit 3258cde

Browse files
docs(zh): improve translations (#3427)
1 parent d2c6e37 commit 3258cde

25 files changed

+106
-105
lines changed

Diff for: docs/.vitepress/config/zh.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ export const zh = defineConfig({
2222
},
2323

2424
footer: {
25-
message: '根据 MIT 许可发布',
26-
copyright: '版权所有 © 2019 至今 尤雨溪'
25+
message: '基于 MIT 许可发布',
26+
copyright: `版权所有 © 2019-${new Date().getFullYear()} 尤雨溪`
2727
},
2828

2929
docFooter: {

Diff for: docs/zh/guide/asset-handling.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## 引用静态资源 {#referencing-static-assets}
44

5-
所有的 Markdown 文件都会被编译成 Vue 组件,并由 [Vite](https://vitejs.dev/guide/assets.html) 处理。可以**并且应该**使用相对路径来引用资源:
5+
所有的 Markdown 文件都会被编译成 Vue 组件,并由 [Vite](https://vitejs.dev/guide/assets.html) 处理。可以**并且应该**使用相对路径来引用资源:
66

77
```md
88
![An image](./image.png)
99
```
1010

11-
可以在 Markdown 文件、主题中的 `*.vue` 组件、样式和普通的 `.css` 文件中引用静态资源,通过使用绝对路径 (基于项目根目录) 或者相对路径 (基于文件系统)。后者类似于 Vite、Vue CLI 或者 webpack 的 `file-loader` 的行为。
11+
可以在 Markdown 文件、主题中的 `*.vue` 组件、样式和普通的 `.css` 文件中引用静态资源,可以使用绝对路径 (基于项目根目录) 或者相对路径 (基于文件系统)。后者类似于 Vite、Vue CLI 或者 webpack 的 `file-loader` 的行为。
1212

1313
常见的图像,媒体和字体文件会被自动检测并视作资源。
1414

@@ -24,7 +24,7 @@
2424

2525
放置在 `public` 中的资源将按原样复制到输出目录的根目录中。
2626

27-
请注意,应使用根绝对路径来引用放置在 `public` 中的文件——例如,`public/icon.png` 应始终在源代码中作为 `/icon.png` 引用。
27+
请注意,应使用根绝对路径来引用放置在 `public` 中的文件——例如,`public/icon.png` 应始终在源代码中使用 `/icon.png` 引用。
2828

2929
## 根 URL {#base-url}
3030

@@ -38,13 +38,13 @@
3838

3939
在这种情况下,更改 `base` 配置值时,**无需**更新该引用。
4040

41-
但是如果你正在编写一个主题组件,它动态地链接到资源,例如一个图片,它的 `src` 基于主题配置值
41+
但是如果你正在编写一个主题组件,它动态地链接到资源,例如一个图片,它的 `src` 基于主题配置
4242

4343
```vue
4444
<img :src="theme.logoPath" />
4545
```
4646

47-
在这种情况下,建议使用 VitePress 提供的 [`withBase` helper](../reference/runtime-api#withbase) 来包装路径
47+
在这种情况下,建议使用 VitePress 提供的 [`withBase` helper](../reference/runtime-api#withbase) 来包括路径
4848

4949
```vue
5050
<script setup>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ outline: deep
5353

5454
## 整合指南 {#integration-guides}
5555

56-
如果你已经写了一篇关于如何将 VitePress 与特定 CMS 集成的指南,请点击下面的“在 GitHub 上编辑此页面”链接将它提交到这里!
56+
如果你已经写了一篇关于如何将 VitePress 与特定的 CMS 集成的指南,请点击下面的“在 GitHub 上编辑此页面”链接将它提交到这里!

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
└─ package.json
1616
```
1717

18-
当检测到存在主题入口文件时,VitePress 总会使用自定义主题而不是默认主题。但你可以[拓展默认主题](./extending-default-theme)来在其基础上实现更高级的自定义。
18+
当检测到存在主题入口文件时,VitePress 总会使用自定义主题而不是默认主题。但你可以[扩展默认主题](./extending-default-theme)来在其基础上实现更高级的自定义。
1919

2020
## 主题接口 {#theme-interface}
2121

@@ -100,15 +100,15 @@ const { page } = useData()
100100
</template>
101101
```
102102

103-
[`useData()`](../reference/runtime-api#usedata) 为我们提供了所有的运行时数据,以便我们根据不同条件渲染不同的布局。我们可以访问的另一个数据是当前页面的 frontmatter。通过利用这个数据,我们允许用户控制每个页面的布局。例如,用户可以指定一个页面是否使用特殊的主页布局:
103+
[`useData()`](../reference/runtime-api#usedata) 为我们提供了所有的运行时数据,以便我们根据不同条件渲染不同的布局。我们可以访问的另一个数据是当前页面的 frontmatter。通过利用这个数据,可以让用户单独控制每个页面的布局。例如,用户可以指定一个页面是否使用特殊的主页布局:
104104

105105
```md
106106
---
107107
layout: home
108108
---
109109
```
110110

111-
并且我们可以调整我们的主题进行处理
111+
并且我们可以调整主题进行处理
112112

113113
```vue{3,12-14}
114114
<script setup>
@@ -158,11 +158,11 @@ const { page, frontmatter } = useData()
158158

159159
如果你希望将主题作为 npm 包来分发,请按照下面的步骤操作:
160160

161-
1. 在包入口将主题对象作为默认导出来导出
161+
1. 在包入口将主题对象使用默认导出
162162

163163
2. 如果合适的话,将主题配置类型定义作为 `ThemeConfig` 导出。
164164

165-
3. 如果主题需要调整 VitePress 配置,请在包的子路径下 (例如 `my-theme/config`) 下导出该配置,以便用户拓展
165+
3. 如果主题需要调整 VitePress 配置,请在包的子路径下 (例如 `my-theme/config`) 下导出该配置,以便用户扩展
166166

167167
4. 记录主题配置选项 (通过配置文件和 frontmatter)。
168168

@@ -179,7 +179,7 @@ import Theme from 'awesome-vitepress-theme'
179179
export default Theme
180180
```
181181

182-
如果主题需要拓展
182+
如果主题需要扩展
183183

184184
```js
185185
// .vitepress/theme/index.js
@@ -193,7 +193,7 @@ export default {
193193
}
194194
```
195195

196-
如果主题需要特殊的 VitePress 配置,也需要在配置中拓展
196+
如果主题需要特殊的 VitePress 配置,也需要在配置中扩展
197197

198198
```ts
199199
// .vitepress/theme/config.ts

Diff for: docs/zh/guide/data-loading.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export default {
2121

2222
数据加载模块只在 Node.js 中执行,因此可以按需导入 Node API 和 npm 依赖。
2323

24-
然后,可以在 `.md` 页面和 `.vue` 组件中使用 `data` 命名导出从该文件中导入数据
24+
然后,可以在 `.md` 页面和 `.vue` 组件中使用 `data` 具名导出从该文件中导入数据
2525

2626
```vue
2727
<script setup>
@@ -39,7 +39,7 @@ import { data } from './example.data.js'
3939
}
4040
```
4141

42-
你会注意到数据加载本身并没有导出 `data`。这是因为 VitePress 在后台调用了 `load()` 方法,并通过名为 `data` 的命名导出隐式地暴露了结果
42+
你会注意到 data loader 本身并没有导出 `data`。这是因为 VitePress 在后台调用了 `load()` 方法,并通过名为 `data` 的具名导出隐式地暴露了结果
4343

4444
即使它是异步的,这也是有效的:
4545

@@ -54,11 +54,11 @@ export default {
5454

5555
## 使用本地文件生成数据 {#data-from-local-files}
5656

57-
当需要基于本地文件生成数据时,应该在数据加载中使用 `watch` 选项,以便这些文件改动时可以触发热更新。
57+
当需要基于本地文件生成数据时,需要在 data loader 中使用 `watch` 选项,以便这些文件改动时可以触发热更新。
5858

5959
`watch` 选项也很方便,因为可以使用 [glob 模式](https://github.com/mrmlnc/fast-glob#pattern-syntax) 匹配多个文件。模式可以相对于数据加载文件本身,`load()` 函数将接收匹配文件的绝对路径。
6060

61-
下面的例子展示了如何使用 [csv-parse](https://github.com/adaltas/node-csv/tree/master/packages/csv-parse/) 加载 CSV 文件并将其转换为 JSON。因为此文件仅在构建时执行,因此不会将 CSV 解析器发送到客户端
61+
下面的例子展示了如何使用 [csv-parse](https://github.com/adaltas/node-csv/tree/master/packages/csv-parse/) 加载 CSV 文件并将其转换为 JSON。因为此文件仅在构建时执行,因此不会将 CSV 解析器发送到客户端
6262

6363
```js
6464
import fs from 'node:fs'
@@ -68,7 +68,8 @@ export default {
6868
watch: ['./data/*.csv'],
6969
load(watchedFiles) {
7070
// watchFiles 是一个所匹配文件的绝对路径的数组。
71-
// 生成一个博客文章元数据数组,可用于在主题布局中呈现列表。
71+
// 生成一个博客文章元数据数组
72+
// 可用于在主题布局中呈现列表。
7273
return watchedFiles.map((file) => {
7374
return parse(fs.readFileSync(file, 'utf-8'), {
7475
columns: true,
@@ -81,7 +82,7 @@ export default {
8182

8283
## `createContentLoader`
8384

84-
当构建一个内容为主的站点时,我们经常需要创建一个“档案”或“索引”页面:一个我们可以列出内容中的所有可用条目的页面,例如博客文章或 API 页面。我们**可以**直接使用数据加载 API 实现这一点,但由于这是一个常见的用例,VitePress 还提供了一个 `createContentLoader` 辅助函数来简化这个过程:
85+
当构建一个内容为主的站点时,我们经常需要创建一个“归档”或“索引”页面:一个我们可以列出内容中的所有可用条目的页面,例如博客文章或 API 页面。我们**可以**直接使用数据加载 API 实现这一点,但由于这会经常使用,VitePress 还提供了一个 `createContentLoader` 辅助函数来简化这个过程:
8586

8687
```js
8788
// posts.data.js
@@ -112,7 +113,7 @@ interface ContentData {
112113
}
113114
```
114115

115-
默认情况下只提供 `url``frontmatter`。这是因为加载的数据将作为 JSON 内联在客户端包中,我们需要谨慎考虑其大小。下面的例子展示了如何使用数据构建最小的博客索引页面:
116+
默认情况下只提供 `url``frontmatter`。这是因为加载的数据将作为 JSON 内联在客户端 bundle 中,我们需要谨慎考虑其大小。下面的例子展示了如何使用数据构建最小的博客索引页面:
116117

117118
```vue
118119
<script setup>
@@ -212,7 +213,7 @@ interface ContentOptions<T = ContentData[]> {
212213
}
213214
```
214215

215-
## 为数据加载器导出类型 {#typed-data-loaders}
216+
## 为 data loader 导出类型 {#typed-data-loaders}
216217

217218
当使用 TypeScript 时,可以像这样为 loader 和 `data` 导出类型:
218219

@@ -237,7 +238,7 @@ export default defineLoader({
237238

238239
## 配置 {#configuration}
239240

240-
要获取数据加载中的配置信息,可以使用如下代码:
241+
要获取 data loader 中的配置信息,可以使用如下代码:
241242

242243
```ts
243244
import type { SiteConfig } from 'vitepress'

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ outline: deep
3333
$ npm run docs:preview
3434
```
3535

36-
`preview` 命令将启动一个本地静态 Web 服务器`http://localhost:4173`该服务器以 `.vitepress/dist` 作为源文件。这是检查生产版本在本地环境中是否正常的一种简单方法。
36+
`preview` 命令将启动一个本地静态 Web 服务 `http://localhost:4173`该服务以 `.vitepress/dist` 作为源文件。这是检查生产版本在本地环境中是否正常的一种简单方法。
3737

3838
3. 可以通过传递 `--port` 作为参数来配置服务器的端口。
3939

@@ -45,13 +45,13 @@ outline: deep
4545
}
4646
```
4747

48-
现在 `docs:preview` 方法将在 `http://localhost:8080` 启动服务器
48+
现在 `docs:preview` 方法将会在 `http://localhost:8080` 启动服务
4949

5050
## 设定 public 根目录 {#setting-a-public-base-path}
5151

52-
默认情况下,我们假设站点将部署在域名 `/`的根路径上。如果站点在子路径中提供服务,例如 `https://mywebsite.com/blog/`,则需要在 VitePress 配置中将 [`base`](../reference/site-config#base)选项设置为 `'/blog/'`
52+
默认情况下,我们假设站点将部署在域名 (`/`) 的根路径上。如果站点在子路径中提供服务,例如 `https://mywebsite.com/blog/`,则需要在 VitePress 配置中将 [`base`](../reference/site-config#base) 选项设置为 `'/blog/'`
5353

54-
**** 如果你使用的是 Github(或 GitLab)页面并部署到 `user.github.io/repo/`,请将 `base` 设置为 `/repo/`
54+
****如果你使用的是 Github(或 GitLab)页面并部署到 `user.github.io/repo/`,请将 `base` 设置为 `/repo/`
5555

5656
## HTTP 缓存标头 {#http-cache-headers}
5757

@@ -73,7 +73,7 @@ Cache-Control: max-age=31536000,immutable
7373
cache-control: immutable
7474
```
7575

76-
注意:该 `_headers` 文件应放置在[public 目录](/guide/asset-handling#the-public-directory)在我们的例子中是 `docs/public/_headers`,以便将其逐字复制到输出目录。
76+
注意:该 `_headers` 文件应放置在 [public 目录](/guide/asset-handling#the-public-directory) (在我们的例子中是 `docs/public/_headers`),以便将其逐字复制到输出目录。
7777

7878
[Netlify 自定义标头文档](https://docs.netlify.com/routing/headers/)
7979

@@ -127,12 +127,12 @@ Cache-Control: max-age=31536000,immutable
127127
name: Deploy VitePress site to Pages
128128

129129
on:
130-
# 在针对 `main` 分支的推送上运行。如果您
130+
# 在针对 `main` 分支的推送上运行。如果你
131131
# 使用 `master` 分支作为默认分支,请将其更改为 `master`
132132
push:
133133
branches: [main]
134134

135-
# 允许您从 Actions 选项卡手动运行此工作流程
135+
# 允许你从 Actions 选项卡手动运行此工作流程
136136
workflow_dispatch:
137137

138138
# 设置 GITHUB_TOKEN 的权限,以允许部署到 GitHub Pages

Diff for: docs/zh/guide/extending-default-theme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ export default {
214214
- `nav-screen-content-before`
215215
- `nav-screen-content-after`
216216

217-
## Using View Transitions API
217+
## 使用视图过渡 API
218218

219219
### 关于外观切换 {#on-appearance-toggle}
220220

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Markdown 拓展 {#markdown-extensions}
1+
# Markdown 扩展 {#markdown-extensions}
22

3-
VitePress 带有内置的 Markdown 拓展
3+
VitePress 带有内置的 Markdown 扩展
44

55
## 标题锚点 {#header-anchors}
66

@@ -58,7 +58,7 @@ VitePress 带有内置的 Markdown 拓展。
5858

5959
外部链接带有 `target="_blank" rel="noreferrer"`
6060

61-
- [vuejs.org](https://vuejs.org)
61+
- [vuejs.org](https://cn.vuejs.org)
6262
- [VitePress on GitHub](https://github.com/vuejs/vitepress)
6363

6464
## frontmatter {#frontmatter}
@@ -634,7 +634,7 @@ const line4 = 'This is line 4'
634634
<<< @/snippets/snippet.cs{1,2,4-6 c#:line-numbers}
635635
```
636636

637-
如果无法从文件拓展名推测出源语言,这将会很有帮助
637+
如果无法从文件扩展名推测出源语言,这将会很有帮助
638638

639639
## 代码组 {#code-groups}
640640

@@ -870,7 +870,7 @@ export default {
870870

871871
## 高级配置 {#advanced-configuration}
872872

873-
VitePress 使用 [markdown-it](https://github.com/markdown-it/markdown-it) 作为 Markdown 渲染器。上面提到的很多拓展功能都是通过自定义插件实现的。可以使用 `.vitepress/config.js` 中的 `markdown` 选项来进一步自定义 `markdown-it` 实例。
873+
VitePress 使用 [markdown-it](https://github.com/markdown-it/markdown-it) 作为 Markdown 渲染器。上面提到的很多扩展功能都是通过自定义插件实现的。可以使用 `.vitepress/config.js` 中的 `markdown` 选项来进一步自定义 `markdown-it` 实例。
874874

875875
```js
876876
import { defineConfig } from 'vitepress'

Diff for: docs/zh/guide/migration-from-vitepress-0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 从 VitePress 0.x 迁移 {#migration-from-vitepress-0-x}
1+
n# 从 VitePress 0.x 迁移 {#migration-from-vitepress-0-x}
22

33
如果你来自 VitePress 0.x 版本,VitePress 有了一些重大更改。请按照本指南了解如何将应用程序迁移到最新的 VitePress。
44

Diff for: docs/zh/guide/mpa-mode.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ document.querySelector('h1').addEventListener('click', () => {
2020

2121
`<script client>` 是 VitePress 独有的功能,而不是 Vue 的功能。它可以在 `.md``.vue` 文件中使用,但只能在 MPA 模式下使用。所有主题组件中的客户端脚本将被打包在一起,而特定页面的客户端脚本将会分开处理。
2222

23-
请注意,`<script client>` **不会被视为 Vue 组件代码**它会看做普通的 JavaScript 模块来处理。因此,只有在站点需要绝对最小的客户端交互性时,才应该使用 MPA 模式。
23+
请注意,`<script client>` **不会被视为 Vue 组件代码**它将是普通的 JavaScript 模块。因此,只有在站点需要绝对最小的客户端交互性时,才应该使用 MPA 模式。

0 commit comments

Comments
 (0)