docs: rename all index.md to README.md

packages/docs/src/index.md → packages/docs/src/README.md

@@ -17,7 +17,7 @@ footer: MIT Licensed | Vssue
 
 Demo of current page is for GitHub.
 
-Go to the [Demo Page](./demo/index.md) for all supported platforms.
+Go to the [Demo Page](./demo/README.md) for all supported platforms.
 
 ::: tip
 After you comment on an issue, the platform will send you emails when new comments come. The emails might be annoying when new users come and leave comments on this demo page.

packages/docs/src/guide/getting-started.md

@@ -129,7 +129,7 @@ npm install @vssue/api-bitbucket-v2
 
 By `import Vssue from 'vssue'` you will get a Vue plugin. Call `Vue.use()` to use it and set the options. A global component named `Vssue` will be registered.
 
-> For the details of options, see [Options Reference - Vssue Options](../options/index.md#vssue-options)
+> For the details of options, see [Options Reference - Vssue Options](../options/README.md#vssue-options)
 
 ```js
 // import vue
@@ -155,7 +155,7 @@ Vue.use(Vssue, {
 
 Then you can use Vssue Component in your [SFC](https://cn.vuejs.org/v2/guide/single-file-components.html):
 
-> For the details of component props, see [Options Reference - Component Props](../options/index.md#component-props)
+> For the details of component props, see [Options Reference - Component Props](../options/README.md#component-props)
 
 ```vue
 <template>
@@ -197,7 +197,7 @@ When you use Vssue as a Plugin by `Vue.use()`, this component has already been r
 
 If you don't want to register it globally, you can import it this way.
 
-Notice that if you only import the Vssue component, there is no "global" options set by `Vue.use()`, and you have to set all required Vssue Options via the prop `options`. See [Component Props - options](../options/index.md#options).
+Notice that if you only import the Vssue component, there is no "global" options set by `Vue.use()`, and you have to set all required Vssue Options via the prop `options`. See [Component Props - options](../options/README.md#options).
 :::
 
 ```vue

packages/docs/src/guide/github.md

@@ -1,6 +1,6 @@
 # GitHub OAuth App
 
-> Vssue can also work with self-hosted GitHub Enterprise Server. Set the `baseURL` options to your Github URL. See [Options Reference - baseURL](../options/index.md#baseurl)
+> Vssue can also work with self-hosted GitHub Enterprise Server. Set the `baseURL` options to your Github URL. See [Options Reference - baseURL](../options/README.md#baseurl)
 
 ## Create a new OAuth App
 

packages/docs/src/guide/gitlab.md

@@ -2,7 +2,7 @@
 
 > See [Gitlab official docs](https://docs.gitlab.com/ce/integration/oauth_provider.html#adding-an-application-through-the-profile) for reference.
 
-> Vssue can also work with self-hosted GitLab. Set the `baseURL` options to your Gitlab URL. See [Options Reference - baseURL](../options/index.md#baseurl)
+> Vssue can also work with self-hosted GitLab. Set the `baseURL` options to your Gitlab URL. See [Options Reference - baseURL](../options/README.md#baseurl)
 
 ## Create a new Application
 

packages/docs/src/guide/vuepress.md

@@ -60,7 +60,7 @@ The only difference is that, you should set `platform` rather than the `api` pac
 ::: tip
 If you don't set the `locale` option, Vssue will use Vuepress's `$lang` as the language of current page.
 
-> See [locale](../options/index.md#locale) of Vssue and [$lang](https://vuepress.vuejs.org/guide/global-computed.html#lang) of Vuepress
+> See [locale](../options/README.md#locale) of Vssue and [$lang](https://vuepress.vuejs.org/guide/global-computed.html#lang) of Vuepress
 :::
 
 ### Use Vssue Component

packages/docs/src/zh/index.md → packages/docs/src/zh/README.md

@@ -17,7 +17,7 @@ footer: MIT Licensed | Vssue
 
 当前页面 Demo 使用的是 GitHub 平台。
 
-你可以前往 [Demo 页面](./demo/index.md) 查看所有支持平台。
+你可以前往 [Demo 页面](./demo/README.md) 查看所有支持平台。
 
 ::: tip 提示
 在你评论了一个 Issue 之后，每当有新评论，平台都会给你发送邮件提醒。有新用户在这个演示页面留下评论时，这些提醒邮件可能会比较烦人。

packages/docs/src/zh/guide/getting-started.md

@@ -129,7 +129,7 @@ npm install @vssue/api-bitbucket-v2
 
 通过 `import Vssue from 'vssue'` 你会得到一个 Vue 插件。调用 `Vue.use()` 来使用它并进行配置。这会注册一个名称为 `Vssue` 的全局组件。
 
-> 关于配置的详情，可以查看 [配置参考 - Vssue 配置](../options/index.md#vssue-配置)
+> 关于配置的详情，可以查看 [配置参考 - Vssue 配置](../options/README.md#vssue-配置)
 
 ```js
 // 引入 vue
@@ -155,7 +155,7 @@ Vue.use(Vssue, {
 
 然后你就可以在 [SFC](https://cn.vuejs.org/v2/guide/single-file-components.html) 中使用 Vssue 组件了：
 
-> 关于组件 Props 的详情，可以查看 [配置参考 - 组件 Props](../options/index.md#组件-props)
+> 关于组件 Props 的详情，可以查看 [配置参考 - 组件 Props](../options/README.md#组件-props)
 
 ```vue
 <template>
@@ -197,7 +197,7 @@ export default {
 
 如果你不想把它注册为全局组件，你可以通过这种方式引入它。
 
-需要注意的是，如果你只作为组件引入 Vssue，就没有通过 `Vue.use()` 设置的“全局”配置了，你必须通过 Prop `options` 传入所有必需的 Vssue 配置。参考 [组件 Props - options](../options/index.md#options)。
+需要注意的是，如果你只作为组件引入 Vssue，就没有通过 `Vue.use()` 设置的“全局”配置了，你必须通过 Prop `options` 传入所有必需的 Vssue 配置。参考 [组件 Props - options](../options/README.md#options)。
 :::
 
 ```vue

packages/docs/src/zh/guide/gitlab.md

@@ -2,7 +2,7 @@
 
 > 查看 [Gitlab 官方文档](https://docs.gitlab.com/ce/integration/oauth_provider.html#adding-an-application-through-the-profile) 作为参考。
 
-> Vssue 同样可以和自己搭建的 GitLab 一起工作。只需要将 `baseURL` 设置为你的 Gitlab URL 即可。查看 [配置参考 - baseURL](../options/index.md#baseurl)
+> Vssue 同样可以和自己搭建的 GitLab 一起工作。只需要将 `baseURL` 设置为你的 Gitlab URL 即可。查看 [配置参考 - baseURL](../options/README.md#baseurl)
 
 ## 创建一个新的 Application
 

packages/docs/src/zh/guide/vuepress.md

@@ -60,7 +60,7 @@ module.exports = {
 ::: tip
 如果你不设置 `locale`，Vssue 会自动使用 Vuepress 的 `$lang` 作为当前页面的语言。
 
-> 参考 Vssue 的 [locale](../options/index.md#locale) 设置，以及 Vuepress 的 [$lang](https://vuepress.vuejs.org/zh/guide/global-computed.html#lang) 属性。
+> 参考 Vssue 的 [locale](../options/README.md#locale) 设置，以及 Vuepress 的 [$lang](https://vuepress.vuejs.org/zh/guide/global-computed.html#lang) 属性。
 :::
 
 ### 使用 Vssue 组件