docs(zh): fix typos, punctuation and broken references (#5189)

* docs(zh): fix typos, missing words and broken references [lunaria-ignore]
pull/4893/merge
SaintaDream 3 months ago committed by GitHub
parent 01987c4c08
commit 4967e9bab4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -52,7 +52,7 @@ description: 将 VitePress 站点部署到 Netlify、Vercel、GitHub Pages 等
默认情况下,我们假设站点将部署在域名 (`/`) 的根路径上。如果站点在子路径中提供服务,例如 `https://mywebsite.com/blog/`,则需要在 VitePress 配置中将 [`base`](../reference/site-config#base) 选项设置为 `'/blog/'`
**例**:如果你使用的是 Github或 GitLab页面并部署到 `user.github.io/repo/`,请将 `base` 设置为 `/repo/`
**例**:如果你使用的是 GitHub或 GitLab页面并部署到 `user.github.io/repo/`,请将 `base` 设置为 `/repo/`
## HTTP 缓存标头 {#http-cache-headers}
@ -201,7 +201,7 @@ Cache-Control: max-age=31536000,immutable
### GitLab Pages
1. 如果你想部署到 `https://<username> .gitlab.io/<repository> /`,将 VitePress 配置中的 `outDir` 设置为 `../public`。将 `base` 选项配置为 `'/<repository>/'`。如果你部署到自定义域名、用户或组织页面,或在 GitLab 中启用了“Use unique domain”设置则不需要 `base`
1. 如果你想部署到 `https://<username>.gitlab.io/<repository>/`,将 VitePress 配置中的 `outDir` 设置为 `../public`。将 `base` 选项配置为 `'/<repository>/'`。如果你部署到自定义域名、用户或组织页面,或在 GitLab 中启用了“Use unique domain”设置则不需要 `base`
2. 在项目的根目录中创建一个名为 `.gitlab-ci.yml` 的文件,其中包含以下内容。每当你更改内容时,这都会构建和部署你的站点:

@ -55,7 +55,7 @@ interface LocaleSpecificConfig<ThemeConfig = any> {
有关自定义默认主题的文本占位符的信息,请参考 [`DefaultTheme.Config`](https://github.com/vuejs/vitepress/blob/main/types/default-theme.d.ts) 接口。不要在 locale 级别覆盖 `themeConfig.algolia``themeConfig.carbonAds`。想获取多语言搜索的信息,请参考 [Algolia 文档](../reference/default-theme-search#i18n)。
**提示**:配置文件也可以是 `docs/.vitepress/config/index.ts`。通过为每个语言环境创建一个配置文件,然后从 `index.ts` 合并并导出它们,可以更好组织文件。
**提示**:配置文件也可以是 `docs/.vitepress/config/index.ts`。通过为每个语言环境创建一个配置文件,然后从 `index.ts` 合并并导出它们,可以更好组织文件。
## 为本地化设置子目录 {#separate-directory-for-each-locale}
@ -79,7 +79,7 @@ docs/
/* /en/:splat 302
```
**提示:** 如果使用上述的方法,可以使用`nf_lang` cookie 来保存用户的语言选择。例如,可以在主题中添加以下代码:
**提示:** 如果使用上述的方法,可以使用 `nf_lang` cookie 来保存用户的语言选择。例如,可以在主题中添加以下代码:
```ts [docs/.vitepress/theme/index.ts]
import DefaultTheme from 'vitepress/theme'

@ -1,4 +1,4 @@
n# 从 VitePress 0.x 迁移 {#migration-from-vitepress-0-x}
# 从 VitePress 0.x 迁移 {#migration-from-vitepress-0-x}
如果你来自 VitePress 0.x 版本VitePress 有了一些重大更改。请按照本指南了解如何将应用程序迁移到最新的 VitePress。
@ -11,13 +11,13 @@ n# 从 VitePress 0.x 迁移 {#migration-from-vitepress-0-x}
- `sidebar` 选项改变了它的结构。
- `children` 现在命名为 `items`
- 顶级侧边栏不包含 `link`。我们打算把它改回来。
- 删除了 `repo`、`repoLabel`、`docsDir`、`docsBranch`、`editLinks`、`editLinkText`,以支持更灵活的api
- 删除了 `repo`、`repoLabel`、`docsDir`、`docsBranch`、`editLinks`、`editLinkText`,以支持更灵活的 API
- 要将带有图标的 GitHub 链接添加到导航,请使用 [社交链接](../reference/default-theme-config#nav) 功能。
- 要添加“编辑此页面”功能,请使用 [编辑链接](../reference/default-theme-edit-link) 功能。
- `lastUpdated` 选项现在分为` config.lastUpdated` 和 `themeConfig.lastUpdatedText`
- `carbonAds.carbon` 更改为 `carbonAds.code`.
- `lastUpdated` 选项现在分为 `config.lastUpdated``themeConfig.lastUpdatedText`
- `carbonAds.carbon` 更改为 `carbonAds.code`
## frontmatter 配置 {#frontmatter-config}
- `home: true` 选项已更改为 `layout: home`。此外,还修改了许多与主页相关的设置以提供附加功能。详情请参阅 [主页指南](../reference/default-theme-home-page)。
- `footer` 选项移至 [`themeConfig.footer`](../reference/default-theme-footer).
- `footer` 选项移至 [`themeConfig.footer`](../reference/default-theme-footer)

@ -2,7 +2,7 @@
description: 在 VitePress 的 Markdown 文件中直接使用 Vue 组件和动态模板功能。
---
# 在 Markdown 使用 Vue {#using-vue-in-markdown}
# 在 Markdown 使用 Vue {#using-vue-in-markdown}
在 VitePress 中,每个 Markdown 文件都被编译成 HTML而且将其作为 [Vue 单文件组件](https://cn.vuejs.org/guide/scaling-up/sfc.html)处理。这意味着可以在 Markdown 中使用任何 Vue 功能,包括动态模板、使用 Vue 组件或通过添加 `<script>` 标签为页面的 Vue 组件添加逻辑。
@ -30,7 +30,7 @@ description: 在 VitePress 的 Markdown 文件中直接使用 Vue 组件和动
### 指令 {#directives}
也可以使用指令 (请注意,原始 HTML 在 Markdown 中也有效):
也可以使用指令 (请注意,原始 HTML 在 Markdown 中也有效)
**输入**

@ -39,7 +39,7 @@ vitepress dev [root]
vitepress build [root]
```
### 选项\
### 选项
| 选项 | 说明 |
| ------------------------------ | ------------------------------------------------------------------------------------------------- |

@ -273,7 +273,7 @@ export interface Footer {
- 类型:`EditLink`
- 每个页面可以通过 [frontmatter](./frontmatter-config#editlink) 覆盖
编辑链接可让显示链接以编辑 Git 管理服务 (例如 GitHub 或 GitLab) 上的页面。有关详细信息,请参阅[默认主题:编辑链接](./default-theme-edit-link)。
编辑链接允许显示一个链接,用于在 Git 管理服务 (例如 GitHub 或 GitLab) 上编辑页面。有关详细信息,请参阅[默认主题:编辑链接](./default-theme-edit-link)。
```ts
export default {

@ -9,9 +9,9 @@ description: 基于 Git 提交历史在 VitePress 页面上显示最后更新时
::: tip
VitePress 通过每个文件最近一次 Git 提交的时间戳显示"最后更新"时间,因此你必须提交 markdown 文件才能看到最后更新时间。
具体实现上VitePress 会对每个文件执行`git log -1 --pretty="%ai"`命令以获取时间戳。若所有页面显示相同的更新时间,可能是由于浅克隆(常见于 CI 环境)导致 Git 历史记录受限所致。
具体实现上VitePress 会对每个文件执行 `git log -1 --pretty="%ai"` 命令以获取时间戳。若所有页面显示相同的更新时间,可能是由于浅克隆(常见于 CI 环境)导致 Git 历史记录受限所致。
**GitHub Actions** 中修复此问题,请在工作流中添加以下配置:
**GitHub Actions** 中修复此问题,请在工作流中添加以下配置:
```yaml{4}
- name: Checkout

@ -16,7 +16,7 @@ layout: doc
`doc` 是默认布局,它将整个 Markdown 内容设置为“documentation”外观。它的工作原理是将整个内容包装在 css `vp-doc` 类中,并将样式应用于它下面的元素。
几乎所有通用元素,例如 `p`,`h2` 都有特殊的样式。因此,请记住,如果在 Markdown 内容中添加任何自定义 HTML这些内容也会受到这些样式的影响。
几乎所有通用元素,例如 `p``h2` 都有特殊的样式。因此,请记住,如果在 Markdown 内容中添加任何自定义 HTML这些内容也会受到这些样式的影响。
它还提供下面列出的文档特定功能。这些功能仅在此布局中启用。
@ -29,7 +29,7 @@ layout: doc
`page` 被视为“空白页”。Markdown 仍然会被解析,所有的 [Markdown 扩展](../guide/markdown) 都和 `doc` 布局一样运行,但它没有任何默认样式。
`page` 布局使可以自行设计所有内容,而不会受 VitePress 主题影响。当想要创建自己的自定义页面时,这很有用。
`page` 布局使可以自行设计所有内容,而不会受 VitePress 主题影响。当想要创建自己的自定义页面时,这很有用。
请注意,即使在此布局中,如果页面具有匹配的侧边栏配置,侧边栏仍会显示。
@ -51,7 +51,7 @@ layout: foo
---
```
这将在上下文中查找注册名为 `foo` 的组件。例如,可以在 `.vitepress/theme/index.ts`中全局注册组件:
这将在上下文中查找注册名为 `foo` 的组件。例如,可以在 `.vitepress/theme/index.ts` 中全局注册组件:
```ts
import DefaultTheme from 'vitepress/theme'

@ -117,9 +117,9 @@ const members = [
创建完整的团队页面时,请记住用 `<VPTeamPage>` 组件包装所有团队相关组件,以获得正确的布局结构,如间距。
`<VPPageTitle>` 组件添加页面标题部分。标题是 `<h1>` 标题。使用 `#title``#lead` 插槽来介绍你的团队。
`<VPTeamPageTitle>` 组件添加页面标题部分。标题是 `<h1>` 标题。使用 `#title``#lead` 插槽来介绍你的团队。
`<VPMembers>` 和在 doc 页面中使用时一样。它将显示成员列表。
`<VPTeamMembers>` 和在 doc 页面中使用时一样。它将显示成员列表。
### 添加 section 以划分团队成员 {#add-sections-to-divide-team-members}
@ -243,7 +243,7 @@ interface TeamMember {
## `<VPTeamPageSection>`
在团队页面中创建一个“section”。它接受 `#title`、`#lead` 和 `#members` 插槽。你可以在 `<VPTeamPage>` 中添加任意数量的section。
在团队页面中创建一个“section”。它接受 `#title`、`#lead` 和 `#members` 插槽。你可以在 `<VPTeamPage>` 中添加任意数量的 section。
```html
<VPTeamPage>

@ -110,7 +110,7 @@ layout: doc
### features <Badge type="info" text="home page only" />
定义当`layout` 设置为 `home` 时要在 features 部分中显示的项目。更多详细信息:[默认主题:主页](./default-theme-home-page)。
定义当 `layout` 设置为 `home` 时要在 features 部分中显示的项目。更多详细信息:[默认主题:主页](./default-theme-home-page)。
### navbar
@ -130,7 +130,7 @@ navbar: false
- 类型:`boolean`
- 默认值:`true`
是否显示 [侧边栏](./default-theme-sidebar).
是否显示 [侧边栏](./default-theme-sidebar)
```yaml
---

@ -144,7 +144,7 @@ export default defineConfigWithTheme<ThemeConfig>({
站点的标题。使用默认主题时,这将显示在导航栏中。
它还将用作所有单独页面标题的默认后缀,除非定义了 [`titleTemplate`](#titletemplate)。单个页面的最终标题将是其第一个 `<h1>` 标题的文本内容加上全局 `title`。例如使用以下配置和页面内容:
它还将用作所有单独页面标题的默认后缀,除非定义了 [`titleTemplate`](#titletemplate)。单个页面的最终标题将是其第一个 `<h1>` 标题的文本内容加上全局 `title`。例如使用以下配置和页面内容:
```ts
export default {
@ -156,7 +156,7 @@ export default {
# Hello
```
页面标题就是 `Hello | My Awesome Site`.
页面标题就是 `Hello | My Awesome Site`
### titleTemplate
@ -176,7 +176,7 @@ export default {
# Hello
```
页面标题就是 `Hello | Custom Suffix`.
页面标题就是 `Hello | Custom Suffix`
要完全自定义标题的呈现方式,可以在 `titleTemplate` 中使用 `:title` 标识符:

Loading…
Cancel
Save