Skip to content

Commit 3603009

Browse files
committed
docs: fix all relative links
1 parent 79cc9b5 commit 3603009

File tree

8 files changed

+30
-140
lines changed

8 files changed

+30
-140
lines changed

packages/docs/docs/guide/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ It is worth noting that during the `prepare` phase, VuePress does the following:
3131
- [Powerful Plugin API](../plugin/README.md)
3232
- [Built-in markdown extensions](markdown.md) optimized for technical documentation
3333
- [Ability to leverage Vue inside markdown files](using-vue.md)
34-
- [Vue-powered custom theme system](custom-themes.md)
34+
- [Vue-powered custom theme system](../theme/README.md)
3535
- [Automatic Service Worker generation](../config/README.md#serviceworker)
3636
- [Google Analytics Integration](../config/README.md#ga)
3737
- ["Last Updated" based on Git](../theme/default-theme-config.md#last-updated)

packages/docs/docs/guide/using-vue.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Directives also work:
5858

5959
### Access to Site & Page Data
6060

61-
The compiled component does not have any private data but does have access to the [site metadata](./custom-themes.md#site-and-page-metadata). For example:
61+
The compiled component does not have any private data but does have access to the [site metadata](../theme/writing-a-theme.md#site-and-page-metadata). For example:
6262

6363
**Input**
6464

@@ -145,7 +145,7 @@ The output HTML is accomplished by [markdown-it](https://github.com/markdown-it/
145145
## Using Pre-processors
146146

147147
VuePress has built-in webpack config for the following pre-processors: `sass`, `scss`, `less`, `stylus` and `pug`. All you need to do is installing the corresponding dependencies. For example, to enable `sass`, install the following in your project:
148-
148+
149149
``` bash
150150
yarn add -D sass-loader node-sass
151151
```
@@ -167,7 +167,7 @@ yarn add -D pug pug-plain-loader
167167

168168
::: tip
169169
If you are a Stylus user, you don't need to install `stylus` and `stylus-loader` in your project because VuePress uses Stylus internally.
170-
170+
171171
For pre-processors that do not have built-in webpack config support, you will need to [extend the internal webpack config](../config/README.md#configurewebpack) in addition to installing the necessary dependencies.
172172
:::
173173

@@ -209,19 +209,19 @@ See [Browser API Access Restrictions](#browser-api-access-restrictions).
209209

210210
- `custom` - boolean
211211

212-
- **Usage**
213-
212+
- **Usage**
213+
214214
The compiled content of the current `.md` file being rendered. This will be very useful when you use [Custom Layout](../theme/default-theme-config.md#custom-layout-for-specific-pages).
215215

216216
``` vue
217217
<Content/>
218218
```
219219

220-
**Also see:**
220+
**Also see:**
221+
222+
- [Custom Themes > Content Outlet](../theme/writing-a-theme.md#content-outlet)
221223

222-
- [Custom Themes > Content Outlet](./custom-themes.md#content-outlet)
223224

224-
225225
### Badge <Badge text="beta" type="warn"/> <Badge text="0.10.1+"/>
226226

227227
- **Props**:
@@ -233,11 +233,11 @@ The compiled content of the current `.md` file being rendered. This will be very
233233
- **Usage**:
234234

235235
You can use this component in header to add some status for some API:
236-
236+
237237
``` md
238238
### Badge <Badge text="beta" type="warn"/> <Badge text="0.10.1+"/>
239-
```
239+
```
240240

241-
**Also see:**
241+
**Also see:**
242242

243243
- [Using Components In Headers](#using-components-in-headers)

packages/docs/docs/plugin/option-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ import { SOURCE_DIR } from '@dynamic/constans'
287287
- Type: `Function`
288288
- Default: `undefined`
289289

290-
A function used to extend or modify the [$page](../miscellaneous/global-computed.md#page) object. This function will be invoking once for each page at compile time.
290+
A function used to extend or modify the [$page](../guide/global-computed.md#page) object. This function will be invoking once for each page at compile time.
291291

292292
```js
293293
module.exports = {

packages/docs/docs/zh/guide/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ VuePress 由两部分组成:一部分是支持用 Vue 开发主题的极简静
1414

1515
- 为技术文档而优化的 [内置 Markdown 拓展](markdown.md)
1616
- [在 Markdown 文件中使用 Vue 组件的能力](using-vue.md)
17-
- [Vue 驱动的自定义主题系统](custom-themes.md)
17+
- [Vue 驱动的自定义主题系统](../theme/README.md)
1818
- [自动生成 Service Worker](../config/README.md#serviceworker)
1919
- [Google Analytics 集成](../config/README.md#ga)
2020
- [基于 Git 的 “最后更新时间”](../theme/default-theme-config.md#最后更新时间)

packages/docs/docs/zh/guide/custom-themes.md

-110
This file was deleted.

packages/docs/docs/zh/guide/frontmatter.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -107,11 +107,11 @@ meta:
107107
- 类型: `boolean`
108108
- 默认值: `undefined`
109109

110-
参考: [默认值 Theme Config > Disable the Navbar](../theme/默认值-theme-config.md#禁用导航栏).
110+
参考: [默认值 Theme Config > Disable the Navbar](../theme/default-theme-config.md#禁用导航栏).
111111

112112
### sidebar
113113

114114
- 类型: `boolean|'auto'`
115115
- 默认值: `undefined`
116116

117-
参考: [默认值 Theme Config > Sidebar](../theme/默认值-theme-config.md#侧边栏).
117+
参考: [默认值 Theme Config > Sidebar](../theme/default-theme-config.md#侧边栏).

packages/docs/docs/zh/guide/using-vue.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export default {
5858

5959
### 访问网站以及页面的数据
6060

61-
编译后的组件没有私有数据,但可以访问 [网站的元数据](./custom-themes.md#网站和页面的元数据),举例来说:
61+
编译后的组件没有私有数据,但可以访问 [网站的元数据](../theme/writing-a-theme.md#网站和页面的元数据),举例来说:
6262

6363
**Input**
6464

@@ -148,7 +148,7 @@ VuePress 对以下预处理器已经内置相关的 webpack 配置:`sass`、`s
148148
``` bash
149149
yarn add -D sass-loader node-sass
150150
```
151-
151+
152152
然后你就可以在 Markdown 或是组件中使用如下代码:
153153

154154
``` vue
@@ -166,7 +166,7 @@ yarn add -D pug pug-plain-loader
166166

167167
::: tip
168168
需要指出的是,如果你是一个 `stylus` 用户,你并不需要在你的项目中安装 `stylus``stylus-loader`,因为 VuePress 已经内置了它们。
169-
169+
170170
对于那些没有内置的预处理器,除了安装对应的依赖,你还需要 [拓展内部的 Webpack 配置](../config/README.md#configurewebpack)
171171
:::
172172

@@ -209,20 +209,20 @@ export default {
209209

210210
- `custom` - boolean
211211

212-
- **用法**
213-
212+
- **用法**
213+
214214

215215
当前的 `.md` 文件渲染的内容,当你在使用 [自定义布局](../theme/default-theme-config.md#特定页面的自定义布局) 时,它将非常有用。
216-
216+
217217
``` vue
218218
<Content/>
219219
```
220220

221-
**参考:**
221+
**参考:**
222+
223+
- [自定义主题 > 获取渲染内容](../theme/writing-a-theme.md#获取渲染内容)
222224

223-
- [自定义主题 > 获取渲染内容](./custom-themes.md#获取渲染内容)
224225

225-
226226
### Badge <Badge text="beta" type="warn"/> <Badge text="0.10.1+"/>
227227

228228
- **Props**:
@@ -234,11 +234,11 @@ export default {
234234
- **Usage**:
235235

236236
你可以在标题中,使用这个组件来为某些 API 添加一些状态:
237-
237+
238238
``` md
239239
### Badge <Badge text="beta" type="warn"/> <Badge text="0.10.1+"/>
240-
```
240+
```
241241

242-
**参考:**
242+
**参考:**
243243

244244
- [在标题中使用组件](#在标题中使用组件)

packages/docs/docs/zh/theme/writing-a-theme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ module.exports = {
139139
}
140140
```
141141

142-
`title`, `description``base` 会从 `.vuepress/config.js` 中对应的的字段复制过来,而 `pages` 是一个包含了每个页面元数据对象的数据,包括它的路径、页面标题(明确地通过 [YAML front matter](./markdown.md#front-matter) 指定,或者通过该页面的第一个标题取到),以及所有源文件中的 `YAML front matter` 的数据。
142+
`title`, `description``base` 会从 `.vuepress/config.js` 中对应的的字段复制过来,而 `pages` 是一个包含了每个页面元数据对象的数据,包括它的路径、页面标题(明确地通过 [YAML front matter](../guide/markdown.md#front-matter) 指定,或者通过该页面的第一个标题取到),以及所有源文件中的 `YAML front matter` 的数据。
143143

144144
下面的这个对象是你正在看的这个页面的 `$page` 的值:
145145

@@ -158,7 +158,7 @@ module.exports = {
158158
最后,别忘了,作为 Vue Router API 的一部分,`this.$route``this.$router` 同样可以使用。
159159

160160
::: tip 提示
161-
`lastUpdated` 是这个文件最后一次 git 提交的 UNIX 时间戳,更多细节请参考:[最后更新时间](../default-theme-config/README.md#最后更新时间)
161+
`lastUpdated` 是这个文件最后一次 git 提交的 UNIX 时间戳,更多细节请参考:[最后更新时间](./default-theme-config.md#最后更新时间)
162162
:::
163163

164164
**参考:**

0 commit comments

Comments
 (0)