diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 513e0e08b562..f3bb8f2c10a0 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 78e74d534d22..0750eb7620c0 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. + - label: Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate. required: true diff --git a/.github/commit-convention.md b/.github/commit-convention.md index 40b187d6acfc..e90c02e4421d 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 021398493cbb..11c8617fe6dd 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -23,7 +23,7 @@ Hi! We're really excited that you are interested in contributing to VitePress. B ## 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/release-tag.yml b/.github/workflows/release-tag.yml new file mode 100644 index 000000000000..110e3fd5a354 --- /dev/null +++ b/.github/workflows/release-tag.yml @@ -0,0 +1,23 @@ +on: + push: + tags: + - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10 + +name: Create Release + +jobs: + build: + name: Create Release + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@master + - name: Create Release for Tag + id: release_tag + uses: yyx990803/release-tag@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ github.ref }} + body: | + Please refer to [CHANGELOG.md](https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md) for details. diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 43b3309ed26e..3445704c73f7 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/CHANGELOG.md b/CHANGELOG.md index 9fc16d760231..18f1c0368565 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,15 @@ +## [0.22.3](https://github.com/vuejs/vitepress/compare/v0.22.2...v0.22.3) (2022-02-22) + +### Bug Fixes + +- append base to links ([#502](https://github.com/vuejs/vitepress/issues/502)) ([804954c](https://github.com/vuejs/vitepress/commit/804954cf4d5417b1abcba9854ed5f064348292c5)), closes [#252](https://github.com/vuejs/vitepress/issues/252) +- avoid minimizing non-javascript inline scripts ([#517](https://github.com/vuejs/vitepress/issues/517)) ([779b789](https://github.com/vuejs/vitepress/commit/779b78902fc7b1f9e7806751c0ca1e229a2161ce)), closes [#538](https://github.com/vuejs/vitepress/issues/538) [#540](https://github.com/vuejs/vitepress/issues/540) +- **client router:** tolerant invalid hash selector typo ([#506](https://github.com/vuejs/vitepress/issues/506)) ([ffe0c40](https://github.com/vuejs/vitepress/commit/ffe0c40ebc42d7769b5378775cdffcab52d3cf11)) +- don't add .html to urls of non-html files ([#515](https://github.com/vuejs/vitepress/issues/515)) ([34d1542](https://github.com/vuejs/vitepress/commit/34d1542f466e2eed28b1be7153d1c3461d84528f)), closes [#265](https://github.com/vuejs/vitepress/issues/265) +- normalize relative img src ([#514](https://github.com/vuejs/vitepress/issues/514)) ([9270477](https://github.com/vuejs/vitepress/commit/9270477fa59545978dc2732ac0a8091bed39625f)), closes [#450](https://github.com/vuejs/vitepress/issues/450) +- require at least node v14 ([#546](https://github.com/vuejs/vitepress/issues/546)) ([7cf7011](https://github.com/vuejs/vitepress/commit/7cf70111a5a00579d46453b682ef33169c7846c5)) +- reset page data on 404 ([#497](https://github.com/vuejs/vitepress/issues/497)) ([28eaa3b](https://github.com/vuejs/vitepress/commit/28eaa3b04ab71674330151d2a9b79d52c382e71e)) + ## [0.22.2](https://github.com/vuejs/vitepress/compare/v0.22.1...v0.22.2) (2022-02-14) ### Features diff --git a/README.md b/README.md index 25db53e63f09..089440fc9db6 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/vitejs/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](https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md). ## 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](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md) before making a pull request. ## License -[MIT](https://opensource.org/licenses/MIT) +[MIT](https://github.com/vuejs/vitepress/blob/main/LICENSE) Copyright (c) 2019-present, Yuxi (Evan) You diff --git a/docs/components/ComponentInHeader.vue b/docs/components/ComponentInHeader.vue index 3999e16ada42..bbccc8ef2eab 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 3ee35eb145ad..28e4e5fd8191 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 56b2268c8121..5955ecb59f33 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 35f77da03d56..0abaad7b7e63 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 924b0272874e..5db50b8c52bc 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 `