docs: use relative file path refs and fix some broken links

ulivz · ulivz · commit 9198f43db4c6 · 2018-05-27T23:55:29.000+08:00
diff --git a/docs/config/README.md b/docs/config/README.md
@@ -123,7 +123,7 @@ Provide config options to the used theme. The options will vary depending on the
 
 **Also see:**
 
-- [Default Theme Configuration](../default-theme-config/).
+- [Default Theme Configuration](../default-theme-config/README.md).
 
 ## Markdown
 
diff --git a/docs/default-theme-config/README.md b/docs/default-theme-config/README.md
@@ -10,7 +10,7 @@ All options listed on this page apply to the default theme only. If you are usin
 
 ## Homepage
 
-The default theme provides a homepage layout (which is used on [the homepage of this very website](/)). To use it, specify `home: true` plus some other metadata in your root `README.md`'s [YAML front matter](../guide/markdown.html#yaml-front-matter). This is the actual data used on this site:
+The default theme provides a homepage layout (which is used on [the homepage of this very website](../README.md)). To use it, specify `home: true` plus some other metadata in your root `README.md`'s [YAML front matter](../guide/markdown.md#front-matter). This is the actual data used on this site:
 
 ``` yaml
 ---
diff --git a/docs/guide/README.md b/docs/guide/README.md
@@ -17,17 +17,17 @@ Each markdown file is compiled into HTML with [markdown-it](https://github.com/m
 - [Built-in markdown extensions](./markdown.md) optimized for technical documentation
 - [Ability to leverage Vue inside markdown files](./using-vue.md)
 - [Vue-powered custom theme system](./custom-themes.md)
-- [Automatic Service Worker generation](../config/#serviceworker)
-- [Google Analytics Integration](../config/#ga)
+- [Automatic Service Worker generation](../config/README.md#serviceworker)
+- [Google Analytics Integration](../config/README.md#ga)
 - ["Last Updated" based on Git](../default-theme-config/README.md#last-updated)
 - [Multi-language support](./i18n.md)
 - A default theme with:
   - Responsive layout
-  - [Optional Homepage](../default-theme-config/#homepage)
-  - [Simple out-of-the-box header-based search](../default-theme-config/#built-in-search)
-  - [Algolia Search](../default-theme-config/#algolia-search)
-  - Customizable [navbar](../default-theme-config/#navbar) and [sidebar](../default-theme-config/#sidebar)
-  - [Auto-generated GitHub link and page edit links](../default-theme-config/#git-repo-and-edit-links)
+  - [Optional Homepage](../default-theme-config/README.md#homepage)
+  - [Simple out-of-the-box header-based search](../default-theme-config/README.md#built-in-search)
+  - [Algolia Search](../default-theme-config/README.md#algolia-search)
+  - Customizable [navbar](../default-theme-config/README.md#navbar) and [sidebar](../default-theme-config/README.md#sidebar)
+  - [Auto-generated GitHub link and page edit links](../default-theme-config/README.md#git-repo-and-edit-links)
 
 ## Todo
 
diff --git a/docs/guide/basic-config.md b/docs/guide/basic-config.md
@@ -24,15 +24,15 @@ module.exports = {
 
 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.
 
-Consult the [Config Reference](../config/) for a full list of options.
+Consult the [Config Reference](../config/README.md) for a full list of options.
 
 ::: tip Alternative Config Formats
 You can also use YAML (`.vuepress/config.yml`) or TOML (`.vuepress/config.toml`) formats for the configuration file.
 :::
 
 ## Theme Configuration
 
-A VuePress theme is responsible for all the layout and interactivity details of your site. VuePress ships with a default theme (you are looking at it right now) which is designed for technical documentation. It exposes a number of options that allow you to customize the navbar, sidebar and homepage, etc. For details, check out the [Default Theme Config](../default-theme-config/) page.
+A VuePress theme is responsible for all the layout and interactivity details of your site. VuePress ships with a default theme (you are looking at it right now) which is designed for technical documentation. It exposes a number of options that allow you to customize the navbar, sidebar and homepage, etc. For details, check out the [Default Theme Config](../default-theme-config/README.md) page.
 
 If you wish to develop a custom theme, see [Custom Themes](./custom-themes.md).
 
diff --git a/docs/guide/custom-themes.md b/docs/guide/custom-themes.md
@@ -38,7 +38,7 @@ This is the value of `$site` of this very website:
 }
 ```
 
-`title`, `description` and `base` are copied from respective fields in `.vuepress/config.js`. `pages` contains an array of metadata objects for each page, including its path, page title (explicitly specified in [YAML front matter](./markdown.html#yaml-front-matter) or inferred from the first header on the page), and any YAML front matter data in that file.
+`title`, `description` and `base` are copied from respective fields in `.vuepress/config.js`. `pages` contains an array of metadata objects for each page, including its path, page title (explicitly specified in [YAML front matter](./markdown.md#front-matter) or inferred from the first header on the page), and any YAML front matter data in that file.
 
 This is the `$page` object for this page you are looking at:
 
@@ -57,7 +57,7 @@ If the user provided `themeConfig` in `.vuepress/config.js`, it will also be ava
 Finally, don't forget that `this.$route` and `this.$router` are also available as part of Vue Router's API.
 
 ::: tip
-  `lastUpdated` is the UNIX timestamp of this file's last git commit, for more details, refer to [Last Updated](../default-theme-config/#last-updated).
+  `lastUpdated` is the UNIX timestamp of this file's last git commit, for more details, refer to [Last Updated](../default-theme-config/README.md#last-updated).
 
 :::
 
diff --git a/docs/guide/i18n.md b/docs/guide/i18n.md
@@ -42,7 +42,7 @@ If a locale does not have `title` or `description` VuePress will fallback to the
 
 ## Default Theme i18n Config
 
-The default theme also has built-in i18n support via `themeConfig.locales`, using the same `{ path: config }` format. Each locale can have its own [nav](../default-theme-config/#navbar-links) and [sidebar](../default-theme-config/#sidebar) config, in addition to a few other text values used across the site:
+The default theme also has built-in i18n support via `themeConfig.locales`, using the same `{ path: config }` format. Each locale can have its own [nav](../default-theme-config/README.md#navbar-links) and [sidebar](../default-theme-config/README.md#sidebar) config, in addition to a few other text values used across the site:
 
 ``` js
 module.exports = {
diff --git a/docs/guide/markdown.md b/docs/guide/markdown.md
@@ -2,7 +2,7 @@
 
 ## Header Anchors
 
-Headers automatically get anchor links applied. Rendering of anchors can be configured using the [`markdown.anchor`](../config/#markdownanchor) option.
+Headers automatically get anchor links applied. Rendering of anchors can be configured using the [`markdown.anchor`](../config/README.md#markdown-anchor) option.
 
 ## Links
 
@@ -53,7 +53,7 @@ Outbound links automatically gets `target="_blank" rel="noopener noreferrer"`:
 - [vuejs.org](https://vuejs.org)
 - [VuePress on GitHub](https://github.com/vuejs/vuepress)
 
-You can customize the attributes added to external links by setting [config.markdown.externalLinks](../config/#markdown-externallinks).
+You can customize the attributes added to external links by setting [config.markdown.externalLinks](../config/README.md#markdown-externallinks).
 
 ## Front Matter
 
@@ -150,7 +150,7 @@ A list of all emojis available can be found [here](https://github.com/markdown-i
 
 [[toc]]
 
-Rendering of TOC can be configured using the [`markdown.toc`](../config/#markdown-toc) option.
+Rendering of TOC can be configured using the [`markdown.toc`](../config/README.md#markdown-toc) option.
 
 ## Custom Containers
 
diff --git a/docs/guide/using-vue.md b/docs/guide/using-vue.md
@@ -152,7 +152,7 @@ yarn add -D pug pug-plain-loader
 ::: tip
 If you are a Stylus user, you don't need to install `stylus` and `stylus-loader` in your project because VuePress uses Stylus internally.
   
-For pre-processors that do not have built-in webpack config support, you will need to [extend the internal webpack config](../config/#configurewebpack) in addition to installing the necessary dependencies.
+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.
 :::
 
 ## Script & Style Hoisting
diff --git a/docs/zh/config/README.md b/docs/zh/config/README.md
@@ -17,7 +17,7 @@ sidebar: auto
 
 **Also see:**
 
-- [Base URL](../guide/assets.md#base-url)
+- [Base URL](../guide/assets.md#基础路径)
 - [部署指南 > Github Pages](../guide/deploy.md#github-pages)
 
 ### title
@@ -122,7 +122,7 @@ module.exports = {
 
 **也可以参考:**
 
-- [默认主题](../default-theme-config/)。
+- [默认主题](../default-theme-config/README.md)。
 
 ## Markdown
 
diff --git a/docs/zh/default-theme-config/README.md b/docs/zh/default-theme-config/README.md
@@ -10,7 +10,7 @@ sidebar: auto
 
 ## 首页
 
-默认的主题提供了一个首页（Homepage）的布局 (用于 [这个网站的主页](/zh/))。想要使用它，需要在你的根级 `README.md` 的 [YAML front matter](../guide/markdown.md#yaml-front-matter) 指定 `home: true`。以下是这个网站实际使用的数据：
+默认的主题提供了一个首页（Homepage）的布局 (用于 [这个网站的主页](../README.md))。想要使用它，需要在你的根级 `README.md` 的 [YAML front matter](../guide/markdown.md#front-matter) 指定 `home: true`。以下是这个网站实际使用的数据：
 
 ``` yaml
 ---
diff --git a/docs/zh/guide/README.md b/docs/zh/guide/README.md
@@ -15,17 +15,17 @@ VuePress 由两部分组成：一部分是支持用 Vue 开发主题的极简静
 - 为技术文档而优化的 [内置 Markdown 拓展](./markdown.md)
 - [在 Markdown 文件中使用 Vue 组件的能力](./using-vue.md)
 - [Vue 驱动的自定义主题系统](./custom-themes.md)
-- [自动生成 Service Worker](../config/#serviceworker)
-- [Google Analytics 集成](../config/#ga)
+- [自动生成 Service Worker](../config/README.md#serviceworker)
+- [Google Analytics 集成](../config/README.md#ga)
 - [基于 Git 的 “最后更新时间”](../default-theme-config/README.md#最后更新时间)
 - [多语言支持](./i18n.md)
 - 默认主题包含：
   - 响应式布局
-  - [可选的主页](../default-theme-config/#首页)
-  - [简洁的开箱即用的标题搜索](../default-theme-config/#内置搜索)
-  - [Algolia 搜索](../default-theme-config/#algolia-搜索)
-  - 可自定义的[导航栏](../default-theme-config/#导航栏) 和[侧边栏](../default-theme-config/#侧边栏)
-  - [自动生成的 GitHub 链接和页面的编辑链接](../default-theme-config/#git-仓库和编辑链接)
+  - [可选的主页](../default-theme-config/README.md#首页)
+  - [简洁的开箱即用的标题搜索](../default-theme-config/README.md#内置搜索)
+  - [Algolia 搜索](../default-theme-config/README.md#algolia-搜索)
+  - 可自定义的[导航栏](../default-theme-config/README.md#导航栏) 和[侧边栏](../default-theme-config/README.md#侧边栏)
+  - [自动生成的 GitHub 链接和页面的编辑链接](../default-theme-config/README.md#git-仓库和编辑链接)
 
 ## Todo
 
diff --git a/docs/zh/guide/assets.md b/docs/zh/guide/assets.md
@@ -17,7 +17,7 @@
 ![Image from dependency](~some-dependency/image.png)
 ```
 
-Webpack 的别名可以通过 `.vuepress/config.js` 中 [configureWebpack](../config/#configurewebpack) 来配置，如：
+Webpack 的别名可以通过 `.vuepress/config.js` 中 [configureWebpack](../config/README.md#configurewebpack) 来配置，如：
 
 ``` js
 module.exports = {
diff --git a/docs/zh/guide/basic-config.md b/docs/zh/guide/basic-config.md
@@ -32,7 +32,7 @@ module.exports = {
 
 ## 主题配置
 
-一个 VuePress 主题应该负责整个网站的布局和交互细节。在 VuePress 中，目前自带了一个默认的主题（正是你现在所看到的），它是为技术文档而设计的。同时，默认主题提供了一些选项，让你可以去自定义导航栏（navbar）、 侧边栏（sidebar）和 首页（homepage） 等，详情请参见 [默认主题](../default-theme-config/) 。
+一个 VuePress 主题应该负责整个网站的布局和交互细节。在 VuePress 中，目前自带了一个默认的主题（正是你现在所看到的），它是为技术文档而设计的。同时，默认主题提供了一些选项，让你可以去自定义导航栏（navbar）、 侧边栏（sidebar）和 首页（homepage） 等，详情请参见 [默认主题](../default-theme-config/README.md) 。
 
 如果你想开发一个自定义主题，可以参考 [自定义主题](./custom-themes.md)。
 
diff --git a/docs/zh/guide/custom-themes.md b/docs/zh/guide/custom-themes.md
@@ -1,7 +1,7 @@
 # 自定义主题
 
 ::: tip 提示
-主题组件受到同样的 [浏览器的 API 访问限制](./using-vue.md#browser-api-access-restrictions)。
+主题组件受到同样的 [浏览器的 API 访问限制](./using-vue.md#浏览器的-api-访问限制)。
 :::
 
 VuePress 使用单文件组件来构建自定义主题。想要开发一个自定义主题，首先在你的文档根目录新建一个 `.vuepress/theme` 文件夹，然后再创建一个 `Layout.vue` 文件：
@@ -38,7 +38,7 @@ VuePress 使用单文件组件来构建自定义主题。想要开发一个自
 }
 ```
 
-`title`, `description` 和 `base` 会从 `.vuepress/config.js` 中对应的的字段复制过来，而 `pages` 是一个包含了每个页面元数据对象的数据，包括它的路径、页面标题（明确地通过 [YAML front matter](./markdown.md#yaml-front-matter) 指定，或者通过该页面的第一个标题取到），以及所有源文件中的 `YAML front matter` 的数据。
+`title`, `description` 和 `base` 会从 `.vuepress/config.js` 中对应的的字段复制过来，而 `pages` 是一个包含了每个页面元数据对象的数据，包括它的路径、页面标题（明确地通过 [YAML front matter](./markdown.md#front-matter) 指定，或者通过该页面的第一个标题取到），以及所有源文件中的 `YAML front matter` 的数据。
 
 下面的这个对象是你正在看的这个页面的 `$page` 的值：
 
@@ -57,7 +57,7 @@ VuePress 使用单文件组件来构建自定义主题。想要开发一个自
 最后，别忘了，作为 Vue Router API 的一部分，`this.$route` 和 `this.$router` 同样可以使用。
 
 ::: tip 提示
-  `lastUpdated` 是这个文件最后一次 git 提交的 UNIX 时间戳，更多细节请参考：[最近更新](../default-theme-config/#最近更新)。
+  `lastUpdated` 是这个文件最后一次 git 提交的 UNIX 时间戳，更多细节请参考：[最后更新时间](../default-theme-config/README.md#最后更新时间)。
 :::
 
 ## 内容摘抄
diff --git a/docs/zh/guide/i18n.md b/docs/zh/guide/i18n.md
@@ -42,7 +42,7 @@ module.exports = {
 
 ## 默认主题多语言配置
 
-默认主题也内置了多语言支持，可以通过 `themeConfig.locales` 来配置。该选项接受同样的 `{ path: config }` 格式的值。每个语言除了可以配置一些站点中用到的文字之外，还可以拥有自己的 [导航栏](../default-theme-config/#导航栏) 和 [侧边栏](../default-theme-config/#侧边栏) 配置：
+默认主题也内置了多语言支持，可以通过 `themeConfig.locales` 来配置。该选项接受同样的 `{ path: config }` 格式的值。每个语言除了可以配置一些站点中用到的文字之外，还可以拥有自己的 [导航栏](../default-theme-config/README.md#导航栏) 和 [侧边栏](../default-theme-config/README.md#侧边栏) 配置：
 
 ``` js
 module.exports = {
diff --git a/docs/zh/guide/markdown.md b/docs/zh/guide/markdown.md
@@ -2,7 +2,7 @@
 
 ## Header Anchors
 
-所有的标题将会自动地应用 anchor 链接，anchor 的渲染可以通过 [`markdown.anchor`](../config/#markdownanchor) 来配置。
+所有的标题将会自动地应用 anchor 链接，anchor 的渲染可以通过 [`markdown.anchor`](../config/README.md#markdown-anchor) 来配置。
 
 ## 链接
 
@@ -53,7 +53,7 @@
 - [vuejs.org](https://vuejs.org)
 - [VuePress on GitHub](https://github.com/vuejs/vuepress)
 
-你可以自定义通过配置 [config.markdown.externalLinks](../config/#markdown-externallinks) 来自定义外部链接的特性。
+你可以自定义通过配置 [config.markdown.externalLinks](../config/README.md#markdown-externallinks) 来自定义外部链接的特性。
 
 ## Front Matter
 
@@ -148,7 +148,7 @@ lang = "en-US"
 
 [[toc]]
 
-目录（Table of Contents）的渲染可以通过  [`markdown.toc`](../config/#markdown-toc) 选项来配置。
+目录（Table of Contents）的渲染可以通过  [`markdown.toc`](../config/README.md#markdown-toc) 选项来配置。
 
 ## 自定义容器
 
diff --git a/docs/zh/guide/using-vue.md b/docs/zh/guide/using-vue.md
@@ -58,7 +58,7 @@ export default {
 
 ### 访问网站以及页面的数据
 
-编译后的组件没有私有数据，但可以访问 [网站的元数据](./custom-themes.md#site-and-page-metadata)，举例来说：
+编译后的组件没有私有数据，但可以访问 [网站的元数据](./custom-themes.md#网站和页面的元数据)，举例来说：
 
 **Input**
 
@@ -153,7 +153,7 @@ yarn add -D pug pug-plain-loader
 ::: tip
 需要指出的是，如果你是一个 `stylus` 用户，你并不需要在你的项目中安装 `stylus` 和 `stylus-loader`，因为 VuePress 已经内置了它们。
   
-对于那些没有内置的预处理器，除了安装对应的依赖，你还需要 [拓展内部的 Webpack 配置](../config/#configurewebpack)。
+对于那些没有内置的预处理器，除了安装对应的依赖，你还需要 [拓展内部的 Webpack 配置](../config/README.md#configurewebpack)。
 :::
 
 
