Skip to content

Commit 271b047

Browse files
ulivzulivz
committed
docs: fix dead links
1 parent 75ab97d commit 271b047

20 files changed

+26
-26
lines changed

‎packages/docs/docs/guide/assets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In addition, you can use the `~` prefix to explicitly indicate this is a webpack
1717
![Image from dependency](~some-dependency/image.png)
1818
```
1919

20-
webpack aliases can be configured via [configureWebpack](../config/config.md#configurewebpack) in `.vuepress/config.js`. Example:
20+
webpack aliases can be configured via [configureWebpack](../config/README.md#configurewebpack) in `.vuepress/config.js`. Example:
2121

2222
``` js
2323
module.exports = {

‎packages/docs/docs/guide/basic-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ module.exports = {
2424

2525
If you've got the dev server running, you should see the page now has a header with the title and a search box. VuePress comes with built-in headers-based search - it automatically builds a simple search index from the title, `h2` and `h3` headers from all the pages.
2626

27-
Consult the [Config Reference](../config/config.md) for a full list of options.
27+
Consult the [Config Reference](../config/README.md) for a full list of options.
2828

2929
::: tip Alternative Config Formats
3030
You can also use YAML (`.vuepress/config.yml`) or TOML (`.vuepress/config.toml`) formats for the configuration file.

‎packages/docs/docs/guide/directory-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ For the above directory structure, the default page routing paths are as follows
6060

6161
**Also see:**
6262

63-
- [Config](../config/config.md)
63+
- [Config](../config/README.md)
6464
- [Theme](../theme/)
6565
- [Default Theme Config](../theme/default-theme-config.md)
6666

‎packages/docs/docs/guide/markdown.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Header Anchors
44

5-
Headers automatically get anchor links applied. Rendering of anchors can be configured using the [`markdown.anchor`](../config/config.md#markdown-anchor) option.
5+
Headers automatically get anchor links applied. Rendering of anchors can be configured using the [`markdown.anchor`](../config/README.md#markdown-anchor) option.
66

77
## Links
88

@@ -53,7 +53,7 @@ Outbound links automatically gets `target="_blank" rel="noopener noreferrer"`:
5353
- [vuejs.org](https://vuejs.org)
5454
- [VuePress on GitHub](https://github.com/vuejs/vuepress)
5555

56-
You can customize the attributes added to external links by setting [config.markdown.externalLinks](../config/config.md#markdown-externallinks).
56+
You can customize the attributes added to external links by setting [config.markdown.externalLinks](../config/README.md#markdown-externallinks).
5757

5858
## Front Matter
5959

@@ -122,7 +122,7 @@ or
122122

123123
[[toc]]
124124

125-
Rendering of TOC can be configured using the [`markdown.toc`](../config/config.md#markdown-toc) option, or as props of [TOC component](./using-vue.md#toc), like `<TOC list-type="ol" :include-level="[2, Infinity]"/>`.
125+
Rendering of TOC can be configured using the [`markdown.toc`](../config/README.md#markdown-toc) option, or as props of [TOC component](./using-vue.md#toc), like `<TOC list-type="ol" :include-level="[2, Infinity]"/>`.
126126

127127
## Custom Containers
128128

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ yarn add -D pug pug-plain-loader
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.
170170

171-
For pre-processors that do not have built-in webpack config support, you will need to [extend the internal webpack config](../config/config.md#configurewebpack) in addition to installing the necessary dependencies.
171+
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

174174
## Script & Style Hoisting

‎packages/docs/docs/miscellaneous/migration-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,13 @@ See: [@vuepress/plugin-pwa > Migration from 0.x](../plugin/official/plugin-pwa.m
6565
Replaced by `.vuepress/styles/palette.styl`.
6666

6767
::: upgrade
68-
See: [Config > palette.styl](../config/config.md#palette-styl)
68+
See: [Config > palette.styl](../config/README.md#palette-styl)
6969
:::
7070

7171
### `.vuepress/style.styl` <Badge text="replaced"/>
7272

7373
Replaced by `.vuepress/styles/index.styl`.
7474

7575
::: upgrade
76-
See: [Config > index.styl](../config/config.md#index-styl)
76+
See: [Config > index.styl](../config/README.md#index-styl)
7777
:::

‎packages/docs/docs/plugin/context-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Output path.
4646

4747
- Type: `string`
4848

49-
See: [base](../config/config.md#base).
49+
See: [base](../config/README.md#base).
5050

5151
## ctx.writeTemp
5252

‎packages/docs/docs/plugin/official/plugin-nprogress.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ $nprogressColor = red
3636

3737
**Also see:**
3838

39-
- [Config Reference > Styling](../../config/config.md#styling)
39+
- [Config Reference > Styling](../../config/README.md#styling)

‎packages/docs/docs/theme/default-theme-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ Note that it's `off` by default. If given a `string`, it will be displayed as a
379379
The `themeConfig.serviceWorker` option allows you to configure the service worker.
380380

381381
::: tip
382-
Please do not confuse this option with [Config > serviceWorker](../config/config.md#serviceworker), [Config > serviceWorker](../config/config.md#serviceworker) is **site-level**, while this option is **theme-level**.
382+
Please do not confuse this option with [Config > serviceWorker](../config/README.md#serviceworker), [Config > serviceWorker](../config/README.md#serviceworker) is **site-level**, while this option is **theme-level**.
383383
:::
384384

385385
### Popup UI to refresh contents <Badge text="0.13.0+"/> <Badge text="beta" type="warn"/>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The compiled content of the current `.md` file being rendered will be available
2929

3030
## Directory Structure
3131

32-
Just one `Layout.vue` might not be enough, and you might also want to define more layout components in the theme for using on different pages. You may also want to customize the [palette](../config/config.md#palette-styl), and even apply some plugins.
32+
Just one `Layout.vue` might not be enough, and you might also want to define more layout components in the theme for using on different pages. You may also want to customize the [palette](../config/README.md#palette-styl), and even apply some plugins.
3333

3434
So it's time to reorganize your theme, an agreed theme directory structure is as follows:
3535

‎packages/docs/docs/zh/guide/assets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
![Image from dependency](~some-dependency/image.png)
1818
```
1919

20-
Webpack 的别名可以通过 `.vuepress/config.js` 中 [configureWebpack](../config/config.md#configurewebpack) 来配置，如：
20+
Webpack 的别名可以通过 `.vuepress/config.js` 中 [configureWebpack](../config/README.md#configurewebpack) 来配置，如：
2121

2222
``` js
2323
module.exports = {

‎packages/docs/docs/zh/guide/basic-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ module.exports = {
2424

2525
对于上述的配置，如果你运行起 dev server，你应该能看到一个页面，它包含一个页头，里面包含一个标题和一个搜索框。VuePress 内置了基于 headers 的搜索 —— 它会自动为所有页面的标题、`h2` 和 `h3` 构建起一个简单的搜索索引。
2626

27-
参见 [配置](../config/config.md) 来查看所有可配置的选项。
27+
参见 [配置](../config/README.md) 来查看所有可配置的选项。
2828

2929
::: tip 其他配置格式
3030
你也可以使用 YAML (`.vuepress/config.yml`) 或是 TOML (`.vuepress/config.toml`) 格式的配置文件。

‎packages/docs/docs/zh/guide/directory-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ VuePress 遵循 **“约定优于配置”** 的原则，推荐的目录结构
5050

5151
**同时阅读:**
5252

53-
- [配置](../config/config.md)
53+
- [配置](../config/README.md)
5454
- [主题](../theme/README.md)
5555
- [默认主题配置](../theme/default-theme-config.md)
5656

‎packages/docs/docs/zh/guide/markdown.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Header Anchors
44

5-
所有的标题将会自动地应用 anchor 链接，anchor 的渲染可以通过 [`markdown.anchor`](../config/config.md#markdown-anchor) 来配置。
5+
所有的标题将会自动地应用 anchor 链接，anchor 的渲染可以通过 [`markdown.anchor`](../config/README.md#markdown-anchor) 来配置。
66

77
## 链接
88

@@ -53,7 +53,7 @@
5353
- [vuejs.org](https://vuejs.org)
5454
- [VuePress on GitHub](https://github.com/vuejs/vuepress)
5555

56-
你可以自定义通过配置 [config.markdown.externalLinks](../config/config.md#markdown-externallinks) 来自定义外部链接的特性。
56+
你可以自定义通过配置 [config.markdown.externalLinks](../config/README.md#markdown-externallinks) 来自定义外部链接的特性。
5757

5858
## Front Matter
5959

@@ -120,7 +120,7 @@ lang: en-US
120120

121121
[[toc]]
122122

123-
目录（Table of Contents）的渲染可以通过 [`markdown.toc`](../config/config.md#markdown-toc) 选项来配置，也可以在 [TOC 组件](./using-vue.md#toc)中直接传入，如 `<TOC list-type="ol" :include-level="[2, Infinity]"/>`。
123+
目录（Table of Contents）的渲染可以通过 [`markdown.toc`](../config/README.md#markdown-toc) 选项来配置，也可以在 [TOC 组件](./using-vue.md#toc)中直接传入，如 `<TOC list-type="ol" :include-level="[2, Infinity]"/>`。
124124

125125
## 自定义容器
126126

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ yarn add -D pug pug-plain-loader
167167
::: tip
168168
需要指出的是，如果你是一个 `stylus` 用户，你并不需要在你的项目中安装 `stylus` 和 `stylus-loader`，因为 VuePress 已经内置了它们。
169169

170-
对于那些没有内置的预处理器，除了安装对应的依赖，你还需要 [拓展内部的 Webpack 配置](../config/config.md#configurewebpack)。
170+
对于那些没有内置的预处理器，除了安装对应的依赖，你还需要 [拓展内部的 Webpack 配置](../config/README.md#configurewebpack)。
171171
:::
172172

173173

‎packages/docs/docs/zh/miscellaneous/migration-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,13 @@ Service Worker 相关的功能已经被分离为一个单独的插件 [@vuepress
6565
使用 `.vuepress/styles/palette.styl` 代替。
6666

6767
::: upgrade
68-
参考: [Config > palette.styl](../config/config.md#palette-styl)
68+
参考: [Config > palette.styl](../config/README.md#palette-styl)
6969
:::
7070

7171
### `.vuepress/style.styl` <Badge text="替换"/>
7272

7373
使用 `.vuepress/styles/index.styl` 代替。
7474

7575
::: upgrade
76-
参考: [Config > index.styl](../config/config.md#index-styl)
76+
参考: [Config > index.styl](../config/README.md#index-styl)
7777
:::

‎packages/docs/docs/zh/plugin/context-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ VuePress 是否运行在生产环境模式下。
4646

4747
- 类型: `string`
4848

49-
参考: [base](../config/config.md#base).
49+
参考: [base](../config/README.md#base).
5050

5151
## ctx.writeTemp
5252

‎packages/docs/docs/zh/plugin/official/plugin-nprogress.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ $nprogressColor = red
3636

3737
**参考：**
3838

39-
- [配置 > Styling](../../config/config.md#styling)
39+
- [配置 > Styling](../../config/README.md#styling)

‎packages/docs/docs/zh/theme/default-theme-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ module.exports = {
374374
`themeConfig.serviceWorker` 允许你去配置 Service Worker。
375375

376376
::: tip 提示
377-
请不要将本选项与 [Config > serviceWorker](../config/config.md#serviceworker) 混淆，[Config > serviceWorker](../config/config.md#serviceworker) 是网站级别的配置，而本选项是主题级别的配置。
377+
请不要将本选项与 [Config > serviceWorker](../config/README.md#serviceworker) 混淆，[Config > serviceWorker](../config/README.md#serviceworker) 是网站级别的配置，而本选项是主题级别的配置。
378378
:::
379379

380380
### 刷新内容的弹窗 <Badge text="0.13.0+"/> <Badge text="beta" type="warn"/>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
## 目录结构
3535

36-
随着需求的变化，只有一个布局组件 `Layout.vue` 可能还不够，你可能想要定义更多的布局组件用于不同的页面，你可能还想要自定义一个[调色板](../config/config.md#palette-styl)，甚至应用一些插件。
36+
随着需求的变化，只有一个布局组件 `Layout.vue` 可能还不够，你可能想要定义更多的布局组件用于不同的页面，你可能还想要自定义一个[调色板](../config/README.md#palette-styl)，甚至应用一些插件。
3737

3838
那么是时候重新组织你的主题了！一个约定的主题的目录结构如下：
3939

0 commit comments

Comments
 (0)