fix(doc) to common using

pull/2249/head
vanch 3 years ago
parent c045f5b16e
commit 08d38fe706

@ -31,7 +31,7 @@
- [/pure.html](/pure.html)
- <pathname:///VitePressCN/pure.html>
请注意,仅在 Markdown 链接中支持 `pathname://`。此外,`pathname://` 默认情况下将在新选项卡中打开链接。可以使用 `target="_self"` 在同一选项卡中打开它:
请注意,仅在 Markdown 链接中支持 `pathname://`。此外,`pathname://` 默认情况下将在新选项卡中打开链接。可以使用 `target="_self"` 在同一选项卡中打开它:
**输入**

@ -128,11 +128,11 @@ Cache-Control: max-age=31536000,immutable
name: Deploy VitePress site to Pages
on:
# 在针对“main”分支的推送上运行。如果使用 `master` 分支作为默认分支请将其更改为“master”
# 在针对“main”分支的推送上运行。如果使用 `master` 分支作为默认分支请将其更改为“master”
push:
branches: [main]
# 允许从 Action 选项卡手动运行此工作流程
# 允许从 Action 选项卡手动运行此工作流程
workflow_dispatch:
# 设置 GITHUB_TOKEN 的权限以允许部署到 GitHub Pages
@ -196,13 +196,13 @@ jobs:
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. 将 `docs/.vitepress/config.js` 中的 `outDir` 设置为 `../public`。如果你想部署到 `https://<username> .gitlab.io/<repository> /`,将 `base` 选项配置为 `'/<repository> /'`
2. 在项目的根目录中创建一个名为 `.gitlab-ci.yml` 的文件,其中包含以下内容。每当您更改内容时,都会自动构建和部署您的网站:
2. 在项目的根目录中创建一个名为 `.gitlab-ci.yml` 的文件,其中包含以下内容。每当你更改内容时,都会自动构建和部署你的网站:
```yaml
image: node:18

@ -52,7 +52,7 @@ $ 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')` 代替。
:::

@ -210,7 +210,7 @@ console.log('Hello, VitePress!')
:::
此外,可以通过在站点配置中添加以下内容来全局设置自定义标题,如果不是用英语书写,这会很有帮助:
此外,可以通过在站点配置中添加以下内容来全局设置自定义标题,如果不是用英语书写,这会很有帮助:
```ts
// config.ts
@ -525,7 +525,7 @@ export default {
你可以在你的代码块中添加 `:line-numbers` / `:no-line-numbers` 标记来覆盖在配置中的设置。
还可以通过在 `:line-numbers` 之后添加 `=` 来自定义起始行号。例如, `:line-numbers=2` 表示代码块中的行号将从“2”开始。
还可以通过在 `:line-numbers` 之后添加 `=` 来自定义起始行号。例如, `:line-numbers=2` 表示代码块中的行号将从“2”开始。
**输入**
@ -598,7 +598,7 @@ const line4 = 'This is line 4'
<<< @/snippets/snippet.js{2}
::: tip
`@` 的值对应于源代码根目录,默认情况下是 VitePress 项目根目录,除非配置了 `srcDir`。或者,也可以从相对路径导入:
`@` 的值对应于源代码根目录,默认情况下是 VitePress 项目根目录,除非配置了 `srcDir`。或者,也可以从相对路径导入:
```md
<<< ../snippets/snippet.js
@ -731,7 +731,7 @@ export default config
你可以在一个 markdown 文件中包含另一个 markdown 文件,甚至嵌套:
::: tip 提示
还可以在 markdown 路径前加上 `@` 前缀,它将充当源根目录。默认情况下它是 VitePress 项目根目录,除非配置了 `srcDir`
还可以在 markdown 路径前加上 `@` 前缀,它将充当源根目录。默认情况下它是 VitePress 项目根目录,除非配置了 `srcDir`
:::
例如,你可以使用以下方式包含一个相对路径的 markdown 文件:

@ -99,7 +99,7 @@ src/getting-started.md --> /getting-started.html
### 链接到非 vitepress 页面 {#linking-to-non-vitepress-pages}
如果您想链接到网站中不是由 VitePress 生成的页面,您需要使用完整的 URL在新选项卡中打开或明确指定 target
如果你想链接到网站中不是由 VitePress 生成的页面,你需要使用完整的 URL在新选项卡中打开或明确指定 target
**Input**
@ -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>

@ -1,6 +1,6 @@
# Sitemap 生成器 {#sitemap-generation}
VitePress 提供开箱即用的为的网站生成 `sitemap.xml` 文件。要启用它,请将以下内容添加到 `.vitepress/config.js` 中:
VitePress 提供开箱即用的为的网站生成 `sitemap.xml` 文件。要启用它,请将以下内容添加到 `.vitepress/config.js` 中:
```ts
import { defineConfig } from 'vitepress'
@ -31,7 +31,7 @@ export default defineConfig({
## `transformItems` Hook
在将站点地图项写入 `sitemap.xml` 文件之前,可以使用 `sitemap.transformItems` 钩子来修改站点地图项。使用站点地图项数组调用此挂钩,并期望返回站点地图项数组。例子:
在将站点地图项写入 `sitemap.xml` 文件之前,可以使用 `sitemap.transformItems` 钩子来修改站点地图项。使用站点地图项数组调用此挂钩,并期望返回站点地图项数组。例子:
```ts
import { defineConfig } from 'vitepress'

@ -177,7 +177,7 @@ export type SidebarItem = {
将此值设置为 `true` 将在页面右侧渲染。\
将此值设置为 `left` 将在页面左侧渲染。
如果您想对所有页面禁用它,您应该使用 `outline: false`
如果你想对所有页面禁用它,你应该使用 `outline: false`
### 大纲层级 {#outline}
@ -382,7 +382,7 @@ Learn more in [Default Theme: Carbon Ads](./default-theme-carbon-ads)
- Type: `DocFooter`
可用于自定义出现在上一篇和下一篇链接上方的文本。 如果不是用英语编写文档,这很有帮助。也可用于全局禁用上一个/下一个链接。如果想选择性地启用/禁用上一个/下一个链接,可以使用 [frontmatter](./default-theme-prev-next-links)。
可用于自定义出现在上一篇和下一篇链接上方的文本。 如果不是用英语编写文档,这很有帮助。也可用于全局禁用上一个/下一个链接。如果想选择性地启用/禁用上一个/下一个链接,可以使用 [frontmatter](./default-theme-prev-next-links)。
```ts
export default {

@ -52,7 +52,7 @@ layout: foo
---
```
这将在上下文中查找注册名为 `foo` 的组件。例如,你可以在 `.vitepress/theme/index.ts`中全局注册的组件:
这将在上下文中查找注册名为 `foo` 的组件。例如,你可以在 `.vitepress/theme/index.ts`中全局注册的组件:
```ts
import DefaultTheme from 'vitepress/theme'

@ -103,7 +103,7 @@ export default defineConfig({
### 自定义渲染内容 {#custom-content-renderer}
可以在索引之前自定义用于渲染 Markdown 内容的函数:
可以在索引之前自定义用于渲染 Markdown 内容的函数:
```ts
import { defineConfig } from 'vitepress'
@ -127,12 +127,12 @@ export default defineConfig({
})
```
该函数将从客户端站点数据中剥离,因此可以在其中使用 Node.js API。
该函数将从客户端站点数据中剥离,因此可以在其中使用 Node.js API。
#### 示例:从搜索中排除页面 {#example-excluding-pages-from-search}
可以通过将 `search: false` 添加到页面的 frontmatter 来从搜索中排除页面。或者,还可以将 `exclude` 函数传递给 `themeConfig.search.options`,以根据相对于 `srcDir` 的路径排除页面:
可以通过将 `search: false` 添加到页面的 `frontmatter` 来从搜索中排除页面。或者:
可以通过将 `search: false` 添加到页面的 frontmatter 来从搜索中排除页面。或者,还可以将 `exclude` 函数传递给 `themeConfig.search.options`,以根据相对于 `srcDir` 的路径排除页面:
可以通过将 `search: false` 添加到页面的 `frontmatter` 来从搜索中排除页面。或者:
```ts
import { defineConfig } from 'vitepress'
@ -155,7 +155,7 @@ export default defineConfig({
```
::: warning 注意
如果提供了自定义的 `_render` 函数,需要自己处理 `search: false` 的 frontmatter。此外在调用 `md.render` 之前,`env` 对象不会完全填充,因此对可选 `env` 属性(如 `frontmatter` )的任何检查都应该在此之后完成。
如果提供了自定义的 `_render` 函数,需要自己处理 `search: false` 的 frontmatter。此外在调用 `md.render` 之前,`env` 对象不会完全填充,因此对可选 `env` 属性(如 `frontmatter` )的任何检查都应该在此之后完成。
:::
#### 示例:转换内容-添加锚点{#example-transforming-content-adding-anchors}

@ -222,7 +222,7 @@ pageClass: custom-page-class
---
```
然后可以在 `.vitepress/theme/custom.css` 文件中自定义该特定页面的样式:
然后可以在 `.vitepress/theme/custom.css` 文件中自定义该特定页面的样式:
```css
.custom-page-class {

@ -656,7 +656,7 @@ interface TransformContext {
}
```
请注意,仅在静态生成站点时才会调用此挂钩。在开发期间不会调用它。如果您需要在开发期间添加动态头条目,您可以使用 [`transformPageData`](#transformpagedata) 钩子来替代:
请注意,仅在静态生成站点时才会调用此挂钩。在开发期间不会调用它。如果你需要在开发期间添加动态头条目,你可以使用 [`transformPageData`](#transformpagedata) 钩子来替代:
```ts
export default {
@ -700,7 +700,7 @@ export default {
`transformPageData` 是一个钩子,用于转换每个页面的 `pageData`。你可以直接改变 `pageData` 或返回将合并到 `PageData` 中的更改值。
::: warning 警告
不要改变 `context` 中的任何东西。请注意,这可能会影响开发服务器的性能,特别是当您在钩子中有一些网络请求或大量计算(例如生成图像)时。您可以通过判断 `process.env.NODE_ENV === 'production'` 匹配符合条件的情况。
不要改变 `context` 中的任何东西。请注意,这可能会影响开发服务器的性能,特别是当你在钩子中有一些网络请求或大量计算(例如生成图像)时。你可以通过判断 `process.env.NODE_ENV === 'production'` 匹配符合条件的情况。
:::
```ts

Loading…
Cancel
Save