Skip to content

Commit

Permalink
update to 1.0.0-rc.24
Browse files Browse the repository at this point in the history
  • Loading branch information
vanchKong committed Oct 26, 2023
1 parent 8e79194 commit 8221164
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 22 deletions.
6 changes: 3 additions & 3 deletions docs/guide/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Cache-Control: max-age=31536000,immutable
- **输出目录:** `docs/.vitepress/dist`
- **node 版本:** `18` (或更高版本)
::: warning
不要为 HTML 代码启用 _Auto Minify_ 等选项。它将从输出中删除对 Vue 有意义的注释。如果被删除,你可能会看到 hydration mismatch 错误
不要为 HTML 代码启用 _Auto Minify_ 等选项。它将从输出中删除对 Vue 有意义的注释。如果被删除,你可能会看到激活不匹配错误
:::

### GitHub Pages
Expand Down Expand Up @@ -195,13 +195,13 @@ Cache-Control: max-age=31536000,immutable

2. 在存储库设置中的 “Pages” 菜单项下,选择 “Build and deployment > Source > GitHub Actions”。

3. 将更改推送到 `main` 分支并等待 GitHub Actions 工作流完成。你应该看到你的站点部署到 `https://<username>.github.io/[repository]/` 或 `https://<custom-domain>/`,这取决于您的设置。你的网站将在每次推送到 `main` 分支时自动部署。
3. 将更改推送到 `main` 分支并等待 GitHub Actions 工作流完成。你应该看到你的站点部署到 `https://<username>.github.io/[repository]/` 或 `https://<custom-domain>/`,这取决于你的设置。你的网站将在每次推送到 `main` 分支时自动部署。

### GitLab Pages

1. 如果你想部署到 `https://<username> .gitlab.io/<repository> /`,将 VitePress 配置中的 `outDir` 设置为 `../public`。将 `base` 选项配置为 `'/<repository>/'`。

2. 在项目的根目录中创建一个名为 `.gitlab-ci.yml` 的文件,其中包含以下内容。每当您更改内容时,这都会构建和部署您的网站
2. 在项目的根目录中创建一个名为 `.gitlab-ci.yml` 的文件,其中包含以下内容。每当你更改内容时,这都会构建和部署你的网站

3. 使用以下内容在项目的根目录中创建一个名为 `.gitlab-ci.yml` 的文件。每当你更改内容时,会自动构建和部署你的站点:

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,13 @@ $ bun add -D vitepress
:::

::: tip 注意
VitePress 是仅 ESM 的软件包。不要使用 `require()` 导入它,并确保最新的 `package.json` 包含 `"type": "module"`,或者更改相关文件的文件扩展名,例如`.vitepress/config.js``.mjs`/`.mts`。更多详情请参考[Vite 故障排除指南](http://vitejs.dev/guide/troubleshooting.html#this-package-is-esm-only)。此外,在异步 CJS 上下文中,您可以使用 `await import('vitepress')` 代替。
VitePress 是仅 ESM 的软件包。不要使用 `require()` 导入它,并确保最新的 `package.json` 包含 `"type": "module"`,或者更改相关文件的文件扩展名,例如`.vitepress/config.js``.mjs`/`.mts`。更多详情请参考[Vite 故障排除指南](http://vitejs.dev/guide/troubleshooting.html#this-package-is-esm-only)。此外,在异步 CJS 上下文中,你可以使用 `await import('vitepress')` 代替。

:::

### 安装向导 {#setup-wizard}

VitePress 附带一个命令行设置向导,可以帮助您构建一个基本项目。安装后,通过运行以下命令启动向导:
VitePress 附带一个命令行设置向导,可以帮助你构建一个基本项目。安装后,通过运行以下命令启动向导:

::: code-group

Expand Down
6 changes: 3 additions & 3 deletions docs/guide/routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ src/getting-started.md --> /getting-started.html

### 链接到非 vitepress 页面 {#linking-to-non-vitepress-pages}

如果您想链接到网站中不是由 VitePress 生成的页面,您需要使用完整的 URL(在新选项卡中打开)或明确指定 target:
如果你想链接到网站中不是由 VitePress 生成的页面,你需要使用完整的 URL(在新选项卡中打开)或明确指定 target:

**Input**

Expand All @@ -113,9 +113,9 @@ src/getting-started.md --> /getting-started.html

::: tip 注意

在 Markdown 链接中,`base` 会自动添加到 URL 前面。这意味着,如果您想链接到 `base` 之外的页面,则链接中需要类似 `../../pure.html` 的内容(由浏览器相对于当前页面解析)。
在 Markdown 链接中,`base` 会自动添加到 URL 前面。这意味着,如果你想链接到 `base` 之外的页面,则链接中需要类似 `../../pure.html` 的内容(由浏览器相对于当前页面解析)。

或者,您可以直接使用锚标记语法
或者,你可以直接使用锚标记语法

```md
<a href="/pure.html" target="_self">Link to pure.html</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/what-is-vitepress.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ VitePress 旨在使用 Markdown 生成内容时提供出色的开发体验。

VitePress 灵感来源于 VuePress。最初的 VuePress 基于 Vue 2 和 webpack。借助 Vue 3 和 Vite,VitePress 提供了更好的开发体验、更好的生产性能、更精美的默认主题和更灵活的自定义 API。

VitePress 和 VuePress 之间的 API 区别主要在于主题和定制。如果您使用的是带有默认主题的 VuePress 1,迁移到 VitePress 应该相对简单。
VitePress 和 VuePress 之间的 API 区别主要在于主题和定制。如果你使用的是带有默认主题的 VuePress 1,迁移到 VitePress 应该相对简单。

VuePress 2 也投入了精力,它也支持 Vue 3 和 Vite,与 VuePress 1 的兼容性更好。但是,并行维护两个 SSG 是难以持续的,因此 Vue 团队决定将重点放在 VitePress,作为长期的主要 SSG 选择推荐。
15 changes: 7 additions & 8 deletions docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,13 @@ vitepress build [root]

### 选项 {#options-1}

| 选项 | 说明 |
| ------------------------------ | ------------------------------------------------------------------------------------------------- |
| `--mpa` (experimental) | 在没有客户端 hydration 的 [MPA 模式](../guide/mpa-mode) 下构建 (`boolean`) |
| `--base <path>` | 公共 base URL (default: `/`) (`string`) |
| `--target <target>` | 转译目标 (default: `"modules"`) (`string`) |
| `--outDir <dir>` | 输出目录 (default: `.vitepress/dist`) (`string`) |
| `--minify [minifier]` | 启用/禁用压缩,或指定要使用的压缩程序 (default: `"esbuild"`) (`boolean \| "terser" \| "esbuild"`) |
| `--assetsInlineLimit <number>` | 静态资源 base64 内联阈值(以字节为单位)(default: `4096`) (`number`) |
| 选项 | 说明 |
| `--mpa` (experimental) | [MPA 模式](../guide/mpa-mode) 下构建,无需客户端激活 (`boolean`) |
| `--base <path>` | 公共 base URL (default: `/`) (`string`) |
| `--target <target>` | 转译目标 (default: `"modules"`) (`string`) |
| `--outDir <dir>` | 输出目录 (default: `.vitepress/dist`) (`string`) |
| `--minify [minifier]` | 启用/禁用压缩,或指定要使用的压缩程序 (default: `"esbuild"`) (`boolean \| "terser" \| "esbuild"`) |
| `--assetsInlineLimit <number>` | 静态资源 base64 内联阈值(以字节为单位)(default: `4096`) (`number`) |

## `vitepress preview`

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/default-theme-footer.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export default {
```

::: warning
只有内联元素可以在 `message``copyright` 中使用,因为它们渲染在 `<p> ` 元素中。如果您想添加块元素,请考虑使用 [`layout-bottom`](../guide/extending-default-theme#layout-slots) 插槽。
只有内联元素可以在 `message``copyright` 中使用,因为它们渲染在 `<p>` 元素中。如果你想添加块元素,请考虑使用 [`layout-bottom`](../guide/extending-default-theme#layout-slots) 插槽。
:::

请注意,当[侧边栏](./default-theme-sidebar)可见时,不会显示页脚。
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/default-theme-last-updated.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ lastUpdated: false
---
```

另请参阅[默认主题:最近更新时间](./default-theme-config#lastupdated) 了解更多详细信息。主题级别的任何真值也将启用该功能,除非在站点或页面级别明确禁用。
另请参阅[默认主题:最近更新时间](./default-theme-config#lastupdated) 了解更多详细信息。主题级别的任何 [truthy](https://developer.mozilla.org/zh-CN/docs/Glossary/Truthy) 值也将启用该功能,除非在站点或页面级别明确禁用。
2 changes: 1 addition & 1 deletion docs/reference/default-theme-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ layout: foo
---
```

这将在上下文中查找注册名为 `foo` 的组件。例如,你可以在 `.vitepress/theme/index.ts`中全局注册您的组件
这将在上下文中查找注册名为 `foo` 的组件。例如,你可以在 `.vitepress/theme/index.ts`中全局注册你的组件

```ts
import DefaultTheme from 'vitepress/theme'
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/site-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -664,7 +664,7 @@ interface TransformContext {
}
```

请注意,仅在静态生成站点时才会调用此挂钩。在开发期间不会调用它。如果您需要在开发期间添加动态头条目,您可以使用 [`transformPageData`](#transformpagedata) 钩子来替代:
请注意,仅在静态生成站点时才会调用此挂钩。在开发期间不会调用它。如果你需要在开发期间添加动态头条目,你可以使用 [`transformPageData`](#transformpagedata) 钩子来替代:

```ts
export default {
Expand Down Expand Up @@ -708,7 +708,7 @@ export default {
`transformPageData` 是一个钩子,用于转换每个页面的 `pageData`。你可以直接改变 `pageData` 或返回将合并到 `PageData` 中的更改值。

::: warning
不要改变 `context` 中的任何东西。请注意,这可能会影响开发服务器的性能,特别是当您在钩子中有一些网络请求或大量计算(例如生成图像)时。您可以通过判断 `process.env.NODE_ENV === 'production'` 匹配符合条件的情况。
不要改变 `context` 中的任何东西。请注意,这可能会影响开发服务器的性能,特别是当你在钩子中有一些网络请求或大量计算(例如生成图像)时。你可以通过判断 `process.env.NODE_ENV === 'production'` 匹配符合条件的情况。
:::

```ts
Expand Down

0 comments on commit 8221164

Please sign in to comment.