msb-public
/
vitepress
mirror of https://github.com/vuejs/vitepress
2
1
Code Issues Projects Releases Wiki Activity

complete `reference`

Browse Source
pull/2249/head
Xavi Lee 2 years ago
parent 4dd71595bb
commit b428122f10
16 changed files with 48 additions and 54 deletions
Show Stats Download Patch File Download Diff File

2
docs/zh/guide/getting-started.md
Unescape View File

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

30
docs/zh/reference/cli.md
Unescape View File

@ -4,13 +4,13 @@
使用指定目录作为根目录来启动 VitePress 开发服务器。默认为当前目录。在当前目录下运行时也可以省略 `dev` 命令。
### 用法 {#usage}
### 用法
```sh
# 从当前目录开始，省略 `dev`
# start in current directory, omitting `dev`
vitepress
# 从子目录开始
# start in sub directory
vitepress dev [root]
```
@ -20,7 +20,7 @@ vitepress dev [root]
| --------------- | ------------------------------------------ |
| `--open [path]` | 启动时打开浏览器 (`boolean \| string`) |
| `--port <port>` | 指定端口 (`number`) |
| `--base <path>` | 公共 base URL (default: `/`) (`string`) |
| `--base <path>` | public base URL (默认值: `/`) (`string`) |
| `--cors` | 启用 CORS |
| `--strictPort` | 如果指定的端口已被占用则退出 (`boolean`) |
| `--force` | 强制优化程序忽略缓存并重新绑定 (`boolean`) |
@ -29,45 +29,45 @@ vitepress dev [root]
构建用于生产环境的 VitePress 站点。
### 用法 {#usage-1}
### 用法
```sh
vitepress build [root]
```
### 选项 {#options-1}
### 选项\
| 选项 | 说明 |
| ------------------------------ | ------------------------------------------------------------------------------------------------- |
| `--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`) |
| `--base <path>` | public base URL (默认值: `/`) (`string`) |
| `--target <target>` | 转译目标 (默认值：`"modules"`) (`string`) |
| `--outDir <dir>` | 输出目录 (默认值：`.vitepress/dist`) (`string`) |
| `--minify [minifier]` | 启用/禁用压缩，或指定要使用的压缩程序 (默认值：`"esbuild"`) (`boolean \| "terser" \| "esbuild"`) |
| `--assetsInlineLimit <number>` | 静态资源 base64 内联阈值（以字节为单位）(默认值：`4096`) (`number`) |
## `vitepress preview`
在本地预览生产版本。
### 用法 {#usage-2}
### 用法
```sh
vitepress preview [root]
```
### 选项 {#options-2}
### 选项
| 选项 | 说明 |
| --------------- | -------------------------------------- |
| `--base <path>` | 公共 base URL (default: `/`) (`string`) |
| `--base <path>` | public base URL (默认值: `/`) (`string`) |
| `--port <port>` | 指定端口 (`number`) |
## `vitepress init`
在当前目录中启动[安装向导](../guide/getting-started#setup-wizard)。
### 用法 {#usage-3}
### 用法
```sh
vitepress init

4
docs/zh/reference/default-theme-badge.md
Unescape View File

@ -22,7 +22,7 @@
## 自定义子节点 {#custom-children}
`<Badge>` 接受 `子节点`, 这将显示在徽标中。
`<Badge>` 接受 `children`，这将显示在徽标中。
```html
### Title <Badge type="info">custom element</Badge>
@ -32,7 +32,7 @@
## 自定义不同类型徽标的背景色 {#customize-type-color}
可以通过覆写 css 来自定义不同类型 `<Badge />` 的样式。以下是默认值。
可以通过覆盖 css 来自定义不同类型 `<Badge />` 的样式。以下是默认值。
```css
:root {

6
docs/zh/reference/default-theme-config.md
Unescape View File

@ -168,7 +168,7 @@ export type SidebarItem = {
- 类型：`boolean | 'left'`
- 默认值：`true`
- 每个页面可以通过 [frontmatter](./frontmatter-config#aside) 覆写
- 每个页面可以通过 [frontmatter](./frontmatter-config#aside) 覆盖
将此值设置为 `false` 可禁用 aside(大纲) 容器。\
将此值设置为 `true` 将在页面右侧渲染。\
@ -179,7 +179,7 @@ export type SidebarItem = {
## outline
- 类型：`Outline | Outline['level'] | false`
- 每个页面可以通过 [frontmatter](./frontmatter-config#outline) 覆写层级
- 每个页面可以通过 [frontmatter](./frontmatter-config#outline) 覆盖层级
将此值设置为 `false` 可禁止渲染大纲容器。更多详情请参考该接口：
@ -278,7 +278,7 @@ export interface Footer {
## editLink
- 类型：`EditLink`
- 每个页面可以通过 [frontmatter](./frontmatter-config#editlink) 覆写
- 每个页面可以通过 [frontmatter](./frontmatter-config#editlink) 覆盖
编辑链接可让显示链接以编辑 Git 管理服务（例如 GitHub 或 GitLab）上的页面。有关详细信息，请参阅 [默认主题：编辑链接](./default-theme-edit-link)。

5
docs/zh/reference/default-theme-edit-link.md
Unescape View File

@ -34,10 +34,9 @@ export default {
}
```
::: details 它不应该有副作用，也不应该访问其范围之外的任何东西，因为它将在浏览器中被序列化和执行。
:::
它不应该有副作用，也不应该访问其范围之外的任何东西，因为它将在浏览器中被序列化和执行。
默认情况下，这将在文档页面底部添加链接文本"Edit this page"。可以通过定义 `text` 选项来自定义此文本。
默认情况下，这将在文档页面底部添加链接文本“Edit this page”。可以通过定义 `text` 选项来自定义此文本。
```js
export default {

2
docs/zh/reference/default-theme-home-page.md
Unescape View File

@ -74,7 +74,7 @@ interface HeroAction {
### 自定义 name 的颜色 {#customizing-the-name-color}
VitePress 通过 (`--vp-c-brand-1`) 设置 `name` 的颜色 .但是，可以通过覆写 `--vp-home-hero-name-color` 变量来自定义此颜色。
VitePress 通过 (`--vp-c-brand-1`) 设置 `name` 的颜色 .但是，可以通过覆盖 `--vp-home-hero-name-color` 变量来自定义此颜色。
```css
:root {

1
docs/zh/reference/default-theme-last-updated.md
Unescape View File

@ -5,6 +5,7 @@
::: tip
你必须提交 markdown 文件才能看到最近更新时间。
:::
## 全局配置 {#site-level-config}
```js

2
docs/zh/reference/default-theme-nav.md
Unescape View File

@ -159,4 +159,4 @@ export default {
## 社交链接 {#social-links}
参考 [`社交链接`](./default-theme-config#sociallinks)。
参考 [`socialLinks`](./default-theme-config#sociallinks)。

12
docs/zh/reference/default-theme-prev-next-links.md
Unescape View File

@ -1,14 +1,12 @@
# 上下页链接 {#prev-next-links}
可以自定义上（下）一篇链接的文本。如果 想在 上（下）一篇 链接上显示与侧边栏上不同的文本(默认显示侧边栏的文本)，这将很有帮助。可以自定义上一页和下一页的文本和链接（显示在文档页脚处）。如果想要的文本与边栏上的文本不同，这会很有帮助。此外，还可以禁用侧边栏中未包含页面的页脚或链接
可以自定义上一页和下一页的文本和链接 (显示在文档页脚处)。如果要使其与侧边栏上的文本不同，这会很有帮助。此外，你可能会发现，要禁用未包含在侧边栏中的页面的页脚或链接时，这很有用。
## 上一页 {#prev}
## prev
- Key: `prev`
- 类型：`string | false | { text?: string; link?: string }`
- Type: `string | false | { text?: string; link?: string }`
- Details:
- 说明：
指定要在指向上一页的链接上显示的文本/链接。如果没有在 frontmatter 中设置它，文本/链接将从侧边栏配置中推断出来。
@ -40,6 +38,6 @@
---
```
## 下一页 {#next}
## next
与 `prev` 相同，但用于下一页。

6
docs/zh/reference/default-theme-search.md
Unescape View File

@ -96,11 +96,11 @@ export default defineConfig({
})
```
在 [MiniSearch docs](https://lucaong.github.io/minisearch/classes/MiniSearch.MiniSearch.html)了解更多信息。
参阅 [MiniSearch 文档](https://lucaong.github.io/minisearch/classes/MiniSearch.MiniSearch.html)了解更多信息。
### 自定义渲染内容 {#custom-content-renderer}
你可以在索引之前自定义用于渲染 Markdown 内容的函数：
可以在索引之前自定义用于渲染 Markdown 内容的函数：
```ts
import { defineConfig } from 'vitepress'
@ -261,7 +261,7 @@ export default defineConfig({
})
```
[这些选项](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts)可以被覆盖。请参阅官方 Algolia 文档以了解更多信息。
[这些选项](https://github.com/vuejs/vitepress/blob/main/types/docsearch.d.ts)可以被覆盖。请参阅 Algolia 官方文档以了解更多信息。
### 爬虫配置 {#crawler-config}

8
docs/zh/reference/default-theme-sidebar.md
Unescape View File

@ -66,7 +66,7 @@ export default {
}
```
可以进一步将侧边栏项目嵌入到 6 级深度，从根级别上计数。请注意，深度超过 6 级嵌套物品被忽略，并且不会在侧边栏上显示。
可以进一步将侧边栏项目嵌入到 6 级深度，从根级别上计数。请注意，深度超过 6 级将被忽略，并且不会在侧边栏上显示。
```js
export default {
@ -95,7 +95,7 @@ export default {
## 多侧边栏 {#multiple-sidebars}
可能会根据页面路径显示不同的侧边栏。例如，如本站点所示，可能希望在文档中创建单独的侧边栏，例如“指引”页面和“配置参考”页面。
可能会根据页面路径显示不同的侧边栏。例如，如本站点所示，可能希望在文档中创建单独的侧边栏，例如“指南”页面和“配置参考”页面。
为此，首先将你的页面组织到每个所需部分的目录中：
@ -200,7 +200,7 @@ export interface DocSidebar {
}
```
**Example:**
**示例：**
```vue
<script setup>
@ -210,6 +210,6 @@ const { hasSidebar } = useSidebar()
</script>
<template>
<div v-if="hasSidebar">仅当侧边栏存在时显示</div>
<div v-if="hasSidebar">Only show when sidebar exists</div>
</template>
```

8
docs/zh/reference/default-theme-team-page.md
Unescape View File

@ -49,9 +49,9 @@ const members = [
]
</script>
# 我们的团队 {#our-team}
# Our Team
向我们出色的团队问好。
Say hello to our awesome team.
<VPTeamMembers size="small" :members="members" />
```
@ -220,9 +220,7 @@ interface TeamMember {
## `<VPTeamPage>`
::: details 创建完整团队页面时的根组件。它只接受一个插槽。它将设置所有传入的团队相关组件的样式。
The root component when creating a full team page. It only accepts a single slot. It will style all passed in team related components.
:::
创建完整团队页面时的根组件。它只接受一个插槽。它将设置所有传入的团队相关组件的样式。
## `<VPTeamPageTitle>`

4
docs/zh/reference/frontmatter-config.md
Unescape View File

@ -4,7 +4,7 @@ outline: deep
# frontmatter 配置 {#frontmatter-config}
frontmatter 支持基于页面的配置。在每个 markdown 文件中，可以使用 frontmatter 配置来覆写站点级别或主题级别的配置选项。此外，还有一些配置选项只能在 frontmatter 中定义。
frontmatter 支持基于页面的配置。在每个 markdown 文件中，可以使用 frontmatter 配置来覆盖站点级别或主题级别的配置选项。此外，还有一些配置选项只能在 frontmatter 中定义。
示例用法：
@ -192,7 +192,7 @@ editLink: false
- 类型：`boolean`
- 默认值：`true`
是否显示 [页脚](./default-theme-footer).
是否显示[页脚](./default-theme-footer)。
```yaml
---

4
docs/zh/reference/runtime-api.md
Unescape View File

@ -133,9 +133,7 @@ interface Router {
由于 VitePress 应用程序在生成静态构建时是在 Node.js 中服务器渲染的，因此任何 Vue 使用都必须符合通用代码要求。简而言之，确保仅在 beforeMount 或 mounted 钩子中访问 Browser/DOM API。
::: details 如果正在使用或演示对 SSR 不友好的组件（例如，包含自定义指令），可以将它们包装在 `ClientOnly` 组件中。
If you are using or demoing components that are not SSR-friendly (for example, contain custom directives), you can wrap them inside the `ClientOnly` component.
:::
如果正在使用或演示对 SSR 不友好的组件 (例如，包含自定义指令)，可以将它们包装在 `ClientOnly` 组件中。
```vue-html
<ClientOnly>

6
docs/zh/reference/site-config.md
Unescape View File

@ -139,7 +139,7 @@ export default defineConfigWithTheme<ThemeConfig>({
- 类型：`string`
- 默认值： `VitePress`
- 每个页面可以通过 [frontmatter](./frontmatter-config#title) 覆写
- 每个页面可以通过 [frontmatter](./frontmatter-config#title) 覆盖
站点的标题。使用默认主题时，这将显示在导航栏中。
@ -160,7 +160,7 @@ export default {
### titleTemplate
- 类型：`string | boolean`
- 每个页面可以通过 [frontmatter](./frontmatter-config#titletemplate) 覆写
- 每个页面可以通过 [frontmatter](./frontmatter-config#titletemplate) 覆盖
允许自定义每个页面的标题后缀或整个标题。例如：
@ -193,7 +193,7 @@ export default {
- 类型：`string`
- 默认值： `A VitePress site`
- 每个页面可以通过 [frontmatter](./frontmatter-config#description) 覆写
- 每个页面可以通过 [frontmatter](./frontmatter-config#description) 覆盖
站点的描述。这将呈现为页面 HTML 中的 `<meta>` 标签。

Write Preview
Loading…
Cancel
Save