From 714124324a7a8f7bcbe0b0a8b247fcb0a08354da Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Tue, 8 Feb 2022 14:15:28 +0530 Subject: [PATCH] docs: update links --- .github/ISSUE_TEMPLATE/bug_report.yml | 6 +++--- .github/ISSUE_TEMPLATE/feature_request.yml | 6 +++--- .github/commit-convention.md | 10 +++++----- .github/contributing.md | 4 ++-- .github/workflows/test.yml | 2 +- README.md | 8 ++++---- docs/components/ComponentInHeader.vue | 2 +- docs/config/algolia-search.md | 4 ++-- docs/config/basics.md | 2 +- docs/config/homepage.md | 1 - docs/guide/api.md | 6 +++--- docs/guide/assets.md | 2 +- docs/guide/configuration.md | 2 +- docs/guide/deploy.md | 12 ++++++------ docs/guide/differences-from-vuepress.md | 9 +++++---- docs/guide/frontmatter.md | 1 - docs/guide/global-component.md | 3 +-- docs/guide/markdown.md | 10 +++++++--- docs/guide/theming.md | 8 +++----- docs/guide/using-vue.md | 10 +++++----- docs/index.md | 2 +- .../components/AlgoliaSearchBox.vue | 19 ++++++------------- src/node/markdown/plugins/containers.ts | 4 +++- src/node/serve/serve.ts | 2 +- 24 files changed, 65 insertions(+), 70 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 513e0e08..f3bb8f2c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,6 @@ name: "\U0001F41E Bug report" description: Create a report to help us improve -labels: ["bug: pending triage"] +labels: ['bug: pending triage'] body: - type: markdown attributes: @@ -52,9 +52,9 @@ body: label: Validations description: Before submitting the issue, please make sure you do the following options: - - label: Follow our [Code of Conduct](https://vuejs.org/coc) + - label: Follow our [Code of Conduct](https://vuejs.org/about/coc.html) required: true - - label: Read the [docs](https://vitepress.vuejs.org/). + - label: Read the [docs](https://vitepress.vuejs.org). required: true - label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate. required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 78e74d53..0e95868a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -35,11 +35,11 @@ body: label: Validations description: Before submitting the issue, please make sure you do the following options: - - label: Follow our [Code of Conduct](https://vuejs.org/coc) + - label: Follow our [Code of Conduct](https://vuejs.org/about/coc.html) required: true - - label: Read the [docs](https://vitepress.vuejs.org/). + - label: Read the [docs](https://vitepress.vuejs.org). required: true - - label: Read the [Contributing Guidelines](https://github.com/vuejs/vitepress/blob/master/.github/contributing.md). + - label: Read the [Contributing Guidelines](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md). required: true - label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate. required: true diff --git a/.github/commit-convention.md b/.github/commit-convention.md index 40b187d6..e90c02e4 100644 --- a/.github/commit-convention.md +++ b/.github/commit-convention.md @@ -6,7 +6,7 @@ Messages must be matched by the following regex: -``` js +```js /^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,50}/ ``` @@ -44,7 +44,7 @@ This reverts commit 667ecc1654a317a13331b17617d973392f415f02. ### Full Message Format -A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**: +A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**: ``` (): @@ -74,9 +74,9 @@ The scope could be anything specifying the place of the commit change. For examp The subject contains a succinct description of the change: -* use the imperative, present tense: "change" not "changed" nor "changes" -* don't capitalize the first letter -* no dot (.) at the end +- use the imperative, present tense: "change" not "changed" nor "changes" +- don't capitalize the first letter +- no dot (.) at the end ### Body diff --git a/.github/contributing.md b/.github/contributing.md index 02139849..3d01e44f 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -19,11 +19,11 @@ Hi! We're really excited that you are interested in contributing to VitePress. B - It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging. -- Commit messages must follow the [commit message convention](./commit-convention.md) so that changelogs can be automatically generated. +- Commit messages must follow the [commit message convention](./commit-convention) so that changelogs can be automatically generated. ## Development Setup -You will need [pnpm](https://pnpm.io/) +You will need [pnpm](https://pnpm.io) After cloning the repo, run: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 43b3309e..3445704c 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -21,7 +21,7 @@ jobs: uses: actions/setup-node@v2 with: node-version: ${{ matrix.node_version }} - cache: "pnpm" + cache: 'pnpm' - name: Install deps run: pnpm install diff --git a/README.md b/README.md index 25db53e6..4debf4e8 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ --- -VitePress is [VuePress](http://vuepress.vuejs.org/)' spiritual successor, built on top of [vite](https://github.com/vuejs/vite). +VitePress is [VuePress](https://vuepress.vuejs.org)' spiritual successor, built on top of [vite](https://github.com/vuejs/vite). ## Documentation @@ -13,14 +13,14 @@ To check out docs, visit [vitepress.vuejs.org](https://vitepress.vuejs.org). ## Changelog -Detailed changes for each release are documented in the [CHANGELOG](https://github.com/vuejs/vitepress/blob/master/CHANGELOG.md). +Detailed changes for each release are documented in the [CHANGELOG](./CHANGELOG). ## Contribution -Please make sure to read the [Contributing Guide](./.github/contributing.md) before making a pull request. +Please make sure to read the [Contributing Guide](./.github/contributing) before making a pull request. ## License -[MIT](https://opensource.org/licenses/MIT) +[MIT](./LICENSE) Copyright (c) 2019-present, Yuxi (Evan) You diff --git a/docs/components/ComponentInHeader.vue b/docs/components/ComponentInHeader.vue index 3999e16a..bbccc8ef 100644 --- a/docs/components/ComponentInHeader.vue +++ b/docs/components/ComponentInHeader.vue @@ -1,3 +1,3 @@ \ No newline at end of file + diff --git a/docs/config/algolia-search.md b/docs/config/algolia-search.md index 3ee35eb1..f4c79693 100644 --- a/docs/config/algolia-search.md +++ b/docs/config/algolia-search.md @@ -1,6 +1,6 @@ # Theme Config: Algolia Search -The `themeConfig.algolia` option allows you to use [Algolia DocSearch](https://docsearch.algolia.com/). To enable it, you need to provide at least apiKey and indexName: +The `themeConfig.algolia` option allows you to use [Algolia DocSearch](https://docsearch.algolia.com). To enable it, you need to provide at least apiKey and indexName: ```js module.exports = { @@ -13,7 +13,7 @@ module.exports = { } ``` -For more options, check out [Algolia DocSearch's documentation](https://docsearch.algolia.com/docs/behavior). You can pass any extra option alongside other options, e.g. passing `searchParameters`: +For more options, check out [Algolia DocSearch's documentation](https://docsearch.algolia.com/docs/api). You can pass any extra option alongside other options, e.g. passing `searchParameters`: ```js module.exports = { diff --git a/docs/config/basics.md b/docs/config/basics.md index 56b2268c..5955ecb5 100644 --- a/docs/config/basics.md +++ b/docs/config/basics.md @@ -1,7 +1,7 @@ # App Config: Basics ::: tip -The config reference is incomplete since the config format may still receive further changes. For a complete reference of the current available options, refer to [config.ts](https://github.com/vuejs/vitepress/blob/master/src/node/config.ts#L15). +The config reference is incomplete since the config format may still receive further changes. For a complete reference of the current available options, refer to [config.ts](https://github.com/vuejs/vitepress/blob/45b65ce8b63bd54f345bfc3383eb2416b6769dc9/src/node/config.ts#L30-L65). ::: ## base diff --git a/docs/config/homepage.md b/docs/config/homepage.md index 35f77da0..0abaad7b 100644 --- a/docs/config/homepage.md +++ b/docs/config/homepage.md @@ -20,5 +20,4 @@ features: details: VitePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded. footer: MIT Licensed | Copyright © 2019-present Evan You --- - ``` diff --git a/docs/guide/api.md b/docs/guide/api.md index 924b0272..5db50b8c 100644 --- a/docs/guide/api.md +++ b/docs/guide/api.md @@ -4,7 +4,7 @@ The following methods are globally importable from `vitepress` and are typically used in custom theme Vue components. However, they are also usable inside `.md` pages because markdown files are compiled into Vue single-file components. -Methods that start with `use*` indicates that it is a [Vue 3 Composition API](https://v3.vuejs.org/guide/composition-api-introduction.html) function that can only be used inside `setup()` or `